consolidate --help text, allow to generate man page.
This commit is contained in:
parent
8fff1f290a
commit
1570b6c088
@ -58,28 +58,43 @@ using namespace ARDOUR_COMMAND_LINE;
|
|||||||
int
|
int
|
||||||
print_help (const char *execname)
|
print_help (const char *execname)
|
||||||
{
|
{
|
||||||
cout << _("Usage: ") << execname << " [OPTION]... [SESSION_NAME]\n\n"
|
// help2man format, http://docopt.org/
|
||||||
<< _(" [SESSION_NAME] Name of session to load\n")
|
// https://www.gnu.org/prep/standards/standards.html#g_t_002d_002dhelp
|
||||||
<< _(" -v, --version Show version information\n")
|
cout
|
||||||
<< _(" -h, --help Print this message\n")
|
<< _("Usage: ") << PROGRAM_NAME << _(" [ OPTIONS ] [ SESSION-NAME ]")
|
||||||
<< _(" -a, --no-announcements Do not contact website for announcements\n")
|
<< "\n\n"
|
||||||
<< _(" -b, --bindings Print all possible keyboard binding names\n")
|
<< _("Ardour is a multichannel hard disk recorder (HDR) and digital audio workstation (DAW).")
|
||||||
<< _(" -B, --bypass-plugins Bypass all plugins in an existing session\n")
|
<< "\n\n"
|
||||||
<< _(" -c, --name <name> Use a specific backend client name, default is ardour\n")
|
<< _("Options:\n")
|
||||||
<< _(" -d, --disable-plugins Disable all plugins in an existing session\n")
|
<< _(" -a, --no-announcements Do not contact website for announcements\n")
|
||||||
<< _(" -D, --debug <options> Set debug flags. Use \"-D list\" to see available options\n")
|
<< _(" -b, --bindings Print all possible keyboard binding names\n")
|
||||||
<< _(" -n, --no-splash Do not show splash screen\n")
|
<< _(" -B, --bypass-plugins Bypass all plugins in an existing session\n")
|
||||||
<< _(" -m, --menus file Use \"file\" to define menus\n")
|
<< _(" -c, --name <name> Use a specific backend client name, default is ardour\n")
|
||||||
<< _(" -N, --new session-name Create a new session from the command line\n")
|
#ifndef NDEBUG
|
||||||
<< _(" -O, --no-hw-optimizations Disable h/w specific optimizations\n")
|
<< _(" -C, --curvetest filename Curve algorithm debugger\n")
|
||||||
<< _(" -P, --no-connect-ports Do not connect any ports at startup\n")
|
|
||||||
<< _(" -S, --sync Draw the gui synchronously \n")
|
|
||||||
#ifdef WINDOWS_VST_SUPPORT
|
|
||||||
<< _(" -V, --novst Do not use VST support\n")
|
|
||||||
#endif
|
#endif
|
||||||
<< _(" -E, --save <file> Load the specified session, save it to <file> and then quit\n")
|
<< _(" -d, --disable-plugins Disable all plugins (safe mode)\n")
|
||||||
<< _(" -C, --curvetest filename Curve algorithm debugger\n")
|
#ifndef NDEBUG
|
||||||
<< _(" -k, --keybindings filename Name of key bindings to load\n")
|
<< _(" -D, --debug <options> Set debug flags. Use \"-D list\" to see available options\n")
|
||||||
|
#endif
|
||||||
|
<< _(" -E, --save <file> Load the specified session, save it to <file> and then quit\n")
|
||||||
|
<< _(" -h, --help Print this message\n")
|
||||||
|
<< _(" -k, --keybindings <file> Name of key bindings to load\n")
|
||||||
|
<< _(" -m, --menus file Use \"file\" to define menus\n")
|
||||||
|
<< _(" -n, --no-splash Do not show splash screen\n")
|
||||||
|
<< _(" -N, --new session-name Create a new session from the command line\n")
|
||||||
|
<< _(" -O, --no-hw-optimizations Disable h/w specific optimizations\n")
|
||||||
|
<< _(" -P, --no-connect-ports Do not connect any ports at startup\n")
|
||||||
|
<< _(" -S, --sync Draw the GUI synchronously\n")
|
||||||
|
<< _(" -T, --template <name> Draw the GUI synchronously\n")
|
||||||
|
<< _(" -U, --uuid <uuid> Set (jack) backend UUID\n")
|
||||||
|
<< _(" -v, --version Use session template\n")
|
||||||
|
#ifdef WINDOWS_VST_SUPPORT
|
||||||
|
<< _(" -V, --novst Disable WindowsVST support\n")
|
||||||
|
#endif
|
||||||
|
<< "\n\n"
|
||||||
|
<< _("Report bugs to http://tracker.ardour.org\n")
|
||||||
|
<< _("Website http://ardour.org\n")
|
||||||
;
|
;
|
||||||
return 1;
|
return 1;
|
||||||
|
|
||||||
@ -226,7 +241,7 @@ ARDOUR_COMMAND_LINE::parse_opts (int argc, char *argv[])
|
|||||||
|
|
||||||
case 'U':
|
case 'U':
|
||||||
backend_session_uuid = optarg;
|
backend_session_uuid = optarg;
|
||||||
break;
|
break;
|
||||||
|
|
||||||
default:
|
default:
|
||||||
return print_help(execname);
|
return print_help(execname);
|
||||||
|
4
wscript
4
wscript
@ -1347,3 +1347,7 @@ def tarball(bld):
|
|||||||
|
|
||||||
def test(bld):
|
def test(bld):
|
||||||
subprocess.call("gtk2_ardour/artest")
|
subprocess.call("gtk2_ardour/artest")
|
||||||
|
|
||||||
|
def help2man(bld):
|
||||||
|
cmd = "help2man -s 1 -N -o ardour.1 -n Ardour --version-string='Ardour %s' gtk2_ardour/ardev" % PROGRAM_VERSION
|
||||||
|
subprocess.call(cmd, shell=True)
|
||||||
|
Loading…
Reference in New Issue
Block a user