Browse Source

provide manpage for symlink non-session-manager. Put manpage install into the right functions in meson.build. Fix typo in help string

tags/v1.4.0
Nils 4 years ago
parent
commit
7c94b07479
7 changed files with 53 additions and 9 deletions
  1. +1
    -1
      docs/api/index.html
  2. +1
    -1
      docs/index.html
  3. +1
    -0
      docs/src/generate.sh
  4. +36
    -0
      docs/src/non-session-manager.1
  5. +1
    -1
      docs/src/nsm-legacy-gui.1
  6. +12
    -5
      meson.build
  7. +1
    -1
      src/legacy-gui.cpp

+ 1
- 1
docs/api/index.html View File

@@ -1452,7 +1452,7 @@ of which might respond to the message by updating their own tempo maps.</p>
<div id="footer">
<div id="footer-text">
Version 1.2<br>
Last updated 2020-07-07 02:52:30 +0200
Last updated 2020-07-07 12:43:32 +0200
</div>
</div>
</body>

+ 1
- 1
docs/index.html View File

@@ -556,7 +556,7 @@ Documentation and tutorials for software-developers will be added at a later dat
<div id="footer">
<div id="footer-text">
Version 1.4<br>
Last updated 2020-07-07 02:52:30 +0200
Last updated 2020-07-07 12:43:32 +0200
</div>
</div>
</body>

+ 1
- 0
docs/src/generate.sh View File

@@ -80,6 +80,7 @@ cd "$ROOT/docs/src" #We tested earlier that a build-dir exists

help2man ../../build/nsmd --version-string="nsmd Version $VERSION" --no-info --include manpage-common.h2m > nsmd.1
help2man ../../build/nsm-legacy-gui --version-string="nsm-legacy-gui Version $VERSION" --no-info --include manpage-common.h2m > nsm-legacy-gui.1
help2man ../../build/nsm-legacy-gui --version-string="nsm-legacy-gui Version $VERSION" --no-info --include manpage-common.h2m > non-session-manager.1
help2man ../../build/nsm-proxy --version-string="nsm-proxy Version $VERSION" --no-info --include manpage-common.h2m > nsm-proxy.1
help2man ../../build/nsm-proxy-gui --version-string="nsm-proxy-gui Version $VERSION" --no-info --include manpage-common.h2m > nsm-proxy-gui.1
help2man ../../build/jackpatch --version-string="jackpatch Version $VERSION" --no-info --include manpage-common.h2m > jackpatch.1


+ 36
- 0
docs/src/non-session-manager.1 View File

@@ -0,0 +1,36 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
.TH NSM-LEGACY-GUI "1" "July 2020" "nsm-legacy-gui Version 1.4" "User Commands"
.SH NAME
nsm-legacy-gui \- manual page for nsm-legacy-gui Version 1.4
.SH DESCRIPTION
legacy\-gui \- FLTK GUI for the 'New Session Manager'
.SS "Usage:"
.IP
legacy\-gui
legacy\-gui \fB\-\-help\fR
.SH OPTIONS
.TP
\fB\-\-help\fR
Show this screen
.TP
\fB\-\-nsm\-url\fR url
Connect to a running nsmd [Example: osc.udp://mycomputer.localdomain:38356/].
.TP
\fB\-\-\fR
Everything after \fB\-\-\fR will be given to nsmd as server options. See nsmd \fB\-\-help\fR .
.PP
For backwards compatibility this executable also exist as symlink 'non\-session\-manager'
.SH "REPORTING BUGS"
https://github.com/linuxaudio/new-session-manager/issues
.SH COPYRIGHT
up to 2020:
Jonathan Moore Liles https://non.tuxfamily.org/

from 2020:
https://github.com/linuxaudio/new-session-manager
.SH "SEE ALSO"
The full documentation for NSM is maintained as html site in your systems doc-dir.
For example:
xdg-open file:///usr/share/doc/new-session-manager/index.html

The documentation can also be found online https://github.com/linuxaudio/new-session-manager

+ 1
- 1
docs/src/nsm-legacy-gui.1 View File

@@ -19,7 +19,7 @@ Connect to a running nsmd [Example: osc.udp://mycomputer.localdomain:38356/].
\fB\-\-\fR
Everything after \fB\-\-\fR will be given to nsmd as server options. See nsmd \fB\-\-help\fR .
.PP
For backwards compatibility this executable also exist as symlink 'non\-session_manager
For backwards compatibility this executable also exist as symlink 'non\-session\-manager'
.SH "REPORTING BUGS"
https://github.com/linuxaudio/new-session-manager/issues
.SH COPYRIGHT


+ 12
- 5
meson.build View File

@@ -52,6 +52,11 @@ executable('nsmd',
install: true,
)

install_man(['docs/src/nsmd.1'])
install_data('docs/index.html', install_dir : get_option('datadir') / 'doc/new-session-manager')
install_data('docs/api/index.html', install_dir : get_option('datadir') / 'doc/new-session-manager/api')
install_data('CHANGELOG', install_dir : get_option('datadir') / 'doc/new-session-manager')
install_data('README.md', install_dir : get_option('datadir') / 'doc/new-session-manager')

#For options see meson_options.txt
#All get_options are default=true
@@ -63,6 +68,8 @@ if get_option('jackpatch')
dependencies: [liblodep, jackdep],
install: true,
)

install_man(['docs/src/jackpatch.1', ])
endif


@@ -94,6 +101,9 @@ if get_option('nsm-proxy')
dependencies: [fltkdep, liblodep, threaddep],
install: true,
)

install_man(['docs/src/nsm-proxy.1', 'docs/src/nsm-proxy-gui.1'])

endif

if get_option('nsm-legacy-gui')
@@ -105,12 +115,9 @@ if get_option('nsm-legacy-gui')
)

install_data('src/org.linuxaudio.nsm-legacy-gui.desktop', install_dir : get_option('datadir') / 'applications')
install_data('docs/index.html', install_dir : get_option('datadir') / 'doc/new-session-manager')
install_data('docs/api/index.html', install_dir : get_option('datadir') / 'doc/new-session-manager/api')
install_data('CHANGELOG', install_dir : get_option('datadir') / 'doc/new-session-manager')
install_data('README.md', install_dir : get_option('datadir') / 'doc/new-session-manager')
install_man(['docs/src/nsmd.1', 'docs/src/nsm-proxy.1', 'docs/src/nsm-proxy-gui.1', 'docs/src/nsm-legacy-gui.1', 'docs/src/jackpatch.1', ])
install_man(['docs/src/nsm-legacy-gui.1', 'docs/src/non-session-manager.1'])

#Symlinking is a one-way operation and can't be uninstalled, we rely on distribution packages for that
meson.add_install_script('sh', '-c',
'ln -sf nsm-legacy-gui ${DESTDIR}@0@/@1@/non-session-manager'.format(
get_option('prefix'), get_option('bindir')))


+ 1
- 1
src/legacy-gui.cpp View File

@@ -1360,7 +1360,7 @@ main (int argc, char **argv )
" --nsm-url url Connect to a running nsmd [Example: osc.udp://mycomputer.localdomain:38356/].\n"
" -- Everything after -- will be given to nsmd as server options. See nsmd --help .\n"
"\n"
"For backwards compatibility this executable also exist as symlink 'non-session_manager\n"
"For backwards compatibility this executable also exist as symlink 'non-session-manager'\n"
"\n"
"";
printf ( usage );


Loading…
Cancel
Save