From 7c94b07479febb4e717f89ae92976f0516712507 Mon Sep 17 00:00:00 2001 From: Nils <> Date: Tue, 7 Jul 2020 12:45:17 +0200 Subject: [PATCH] provide manpage for symlink non-session-manager. Put manpage install into the right functions in meson.build. Fix typo in help string --- docs/api/index.html | 2 +- docs/index.html | 2 +- docs/src/generate.sh | 1 + docs/src/non-session-manager.1 | 36 ++++++++++++++++++++++++++++++++++ docs/src/nsm-legacy-gui.1 | 2 +- meson.build | 17 +++++++++++----- src/legacy-gui.cpp | 2 +- 7 files changed, 53 insertions(+), 9 deletions(-) create mode 100644 docs/src/non-session-manager.1 diff --git a/docs/api/index.html b/docs/api/index.html index 04b80f1..93aadfb 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -1452,7 +1452,7 @@ of which might respond to the message by updating their own tempo maps.

diff --git a/docs/index.html b/docs/index.html index 3060771..90703b9 100644 --- a/docs/index.html +++ b/docs/index.html @@ -556,7 +556,7 @@ Documentation and tutorials for software-developers will be added at a later dat diff --git a/docs/src/generate.sh b/docs/src/generate.sh index 8eec4e4..aef061e 100755 --- a/docs/src/generate.sh +++ b/docs/src/generate.sh @@ -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 diff --git a/docs/src/non-session-manager.1 b/docs/src/non-session-manager.1 new file mode 100644 index 0000000..72c8fc2 --- /dev/null +++ b/docs/src/non-session-manager.1 @@ -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 diff --git a/docs/src/nsm-legacy-gui.1 b/docs/src/nsm-legacy-gui.1 index 1824dbe..72c8fc2 100644 --- a/docs/src/nsm-legacy-gui.1 +++ b/docs/src/nsm-legacy-gui.1 @@ -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 diff --git a/meson.build b/meson.build index 349d238..05b2360 100644 --- a/meson.build +++ b/meson.build @@ -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'))) diff --git a/src/legacy-gui.cpp b/src/legacy-gui.cpp index 42d24c7..21cf946 100644 --- a/src/legacy-gui.cpp +++ b/src/legacy-gui.cpp @@ -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 );