From 6e3b2edff8cfeebac2c47d40d20d583b91016de8 Mon Sep 17 00:00:00 2001 From: Colin Clark Date: Thu, 31 Mar 2016 16:58:51 +0100 Subject: [PATCH] Update command line options documentation Update both the Help file documentation for command line options, and the output of the -h and -rh command line parameters. --- doc/docbook/GuideReferenceCommandLine.xml | 75 ++++++++++++++++++----- src/main.c | 24 ++++---- src/remote.c | 61 ++++++++++-------- 3 files changed, 106 insertions(+), 54 deletions(-) diff --git a/doc/docbook/GuideReferenceCommandLine.xml b/doc/docbook/GuideReferenceCommandLine.xml index 1294df7d..e23f5831 100644 --- a/doc/docbook/GuideReferenceCommandLine.xml +++ b/doc/docbook/GuideReferenceCommandLine.xml @@ -42,12 +42,22 @@ Start up in slideshow mode. - -l + -l [filelist] [collectionlist] - --list + --list [filelist] [collectionlist] Open collection window containing images specified on the command line. Any collections on the command line will also be appended to this collection. + + --blank + + Start with file list blank. + + + --geometry=<w>x<h>+<x>+<y> + + Set the <width> <height> <xoffset> <yoffset> of the window. The parameters are in pixels. + -r @@ -77,9 +87,14 @@ Display version of Geeqie. - --debug + --debug[=<level>] + + Turn on debugging output (when compiled with Debug enabled). <level> is 0 to 4. + + + --alternate - Enable Debug output to console. + Use alternate similarity algorithm - experimental - requires re-compile.
@@ -161,19 +176,17 @@ </entry><entry> Stop slide show for main window. </entry></row> -<row><entry> - -sr&lt;folder&gt; - </entry><entry> - --slideshow-recurse&lt;folder&gt; +<row><entry/><entry> + --slideshow-recurse:<folder> </entry><entry> - Start recursive slide show for &lt;folder&gt; in main window. + Start recursive slide show for <folder> in main window. </entry></row> <row><entry> - -d&lt;n&gt; + -d<[n][.m]> </entry><entry> - --delay=&lt;n&gt; + --delay=<[n][.m]> </entry><entry> - Set slide show delay to &lt;n&gt; seconds, range is 0.1 to 3600 + Set slide show delay to <[n][.m]> seconds, range is 0.1 to 3600 </entry></row> <row><entry> +t @@ -197,14 +210,44 @@ Quit Geeqie. </entry></row> <row><entry/><entry> - file:&lt;filename&gt; + --config-load:<file> + </entry><entry> + Load configuration from <file>. + </entry></row> +<row><entry/><entry> + --get-sidecars:<file> + </entry><entry> + Get list of sidecars of <file>. + </entry></row> +<row><entry/><entry> + --get-destination:<file> + </entry><entry> + Get destination path of <file>. This is used by the symlink desktop file to implement the symbolic link operation. There is no useful function for the user. + </entry></row> +<row><entry/><entry> + file:<file> + </entry><entry> + Change main window to display <file> + </entry></row> +<row><entry/><entry> + view:<file> + </entry><entry> + Open new window containing <file> + </entry></row> +<row><entry/><entry> + --list-clear + </entry><entry> + Clear command line collection list + </entry></row> +<row><entry/><entry> + --list-add:<file> </entry><entry> - Change main window to display &lt;filename&gt; + Add <file> to command line collection list </entry></row> <row><entry/><entry> - view:&lt;filename&gt; + raise </entry><entry> - Open new window containing &lt;filename&gt; + Bring the geeqie window to the top </entry></row> </tbody></tgroup></informaltable> <para/></section></section> diff --git a/src/main.c b/src/main.c index 2ce0d672..9912bbe7 100644 --- a/src/main.c +++ b/src/main.c @@ -320,19 +320,20 @@ static void parse_command_line(gint argc, gchar *argv[]) printf_term("%s %s\n", GQ_APPNAME, VERSION); printf_term(_("Usage: %s [options] [path]\n\n"), GQ_APPNAME_LC); print_term(_("valid options are:\n")); - print_term(_(" +t, --with-tools force show of tools\n")); - print_term(_(" -t, --without-tools force hide of tools\n")); - print_term(_(" -f, --fullscreen start in full screen mode\n")); - print_term(_(" -s, --slideshow start in slideshow mode\n")); - print_term(_(" -l, --list open collection window for command line\n")); - print_term(_(" --geometry=GEOMETRY set main window location\n")); - print_term(_(" -r, --remote send following commands to open window\n")); - print_term(_(" -rh,--remote-help print remote command list\n")); + print_term(_(" +t, --with-tools force show of tools\n")); + print_term(_(" -t, --without-tools force hide of tools\n")); + print_term(_(" -f, --fullscreen start in full screen mode\n")); + print_term(_(" -s, --slideshow start in slideshow mode\n")); + print_term(_(" -l, --list [files] [collections] open collection window for command line\n")); + print_term(_(" --blank start with blank file list\n")); + print_term(_(" --geometry=XxY+XOFF+YOFF set main window location\n")); + print_term(_(" -r, --remote send following commands to open window\n")); + print_term(_(" -rh,--remote-help print remote command list\n")); #ifdef DEBUG - print_term(_(" --debug[=level] turn on debug output\n")); + print_term(_(" --debug[=level] turn on debug output\n")); #endif - print_term(_(" -v, --version print version info\n")); - print_term(_(" -h, --help show this message\n\n")); + print_term(_(" -v, --version print version info\n")); + print_term(_(" -h, --help show this message\n\n")); #if 0 /* these options are not officially supported! @@ -340,6 +341,7 @@ static void parse_command_line(gint argc, gchar *argv[]) print_term( " --alternate use alternate similarity algorithm\n"); #endif + exit(0); } else if (!remote_do) diff --git a/src/remote.c b/src/remote.c index 579811ab..df2b691f 100644 --- a/src/remote.c +++ b/src/remote.c @@ -631,34 +631,35 @@ struct _RemoteCommandEntry { void (*func)(const gchar *text, GIOChannel *channel, gpointer data); gboolean needs_extra; gboolean prefer_command_line; + gchar *parameter; gchar *description; }; static RemoteCommandEntry remote_commands[] = { - /* short, long callback, extra, prefer,description */ - { "-n", "--next", gr_image_next, FALSE, FALSE, N_("next image") }, - { "-b", "--back", gr_image_prev, FALSE, FALSE, N_("previous image") }, - { NULL, "--first", gr_image_first, FALSE, FALSE, N_("first image") }, - { NULL, "--last", gr_image_last, FALSE, FALSE, N_("last image") }, - { "-f", "--fullscreen", gr_fullscreen_toggle, FALSE, TRUE, N_("toggle full screen") }, - { "-fs","--fullscreen-start", gr_fullscreen_start, FALSE, FALSE, N_("start full screen") }, - { "-fS","--fullscreen-stop", gr_fullscreen_stop, FALSE, FALSE, N_("stop full screen") }, - { "-s", "--slideshow", gr_slideshow_toggle, FALSE, TRUE, N_("toggle slide show") }, - { "-ss","--slideshow-start", gr_slideshow_start, FALSE, FALSE, N_("start slide show") }, - { "-sS","--slideshow-stop", gr_slideshow_stop, FALSE, FALSE, N_("stop slide show") }, - { NULL, "--slideshow-recurse:", gr_slideshow_start_rec, TRUE, FALSE, N_("start recursive slide show") }, - { "-d", "--delay=", gr_slideshow_delay, TRUE, FALSE, N_("set slide show delay in seconds") }, - { "+t", "--tools-show", gr_tools_show, FALSE, TRUE, N_("show tools") }, - { "-t", "--tools-hide", gr_tools_hide, FALSE, TRUE, N_("hide tools") }, - { "-q", "--quit", gr_quit, FALSE, FALSE, N_("quit") }, - { NULL, "--config-load:", gr_config_load, TRUE, FALSE, N_("load config file") }, - { NULL, "--get-sidecars:", gr_get_sidecars, TRUE, FALSE, N_("get list of sidecars of the given file") }, - { NULL, "--get-destination:", gr_get_destination, TRUE, FALSE, N_("get destination path for the given file") }, - { NULL, "file:", gr_file_load, TRUE, FALSE, N_("open file") }, - { NULL, "view:", gr_file_view, TRUE, FALSE, N_("open file in new window") }, - { NULL, "--list-clear", gr_list_clear, FALSE, FALSE, NULL }, - { NULL, "--list-add:", gr_list_add, TRUE, FALSE, NULL }, - { NULL, "raise", gr_raise, FALSE, FALSE, NULL }, + /* short, long callback, extra, prefer, parameter, description */ + { "-n", "--next", gr_image_next, FALSE, FALSE, NULL, N_("next image") }, + { "-b", "--back", gr_image_prev, FALSE, FALSE, NULL, N_("previous image") }, + { NULL, "--first", gr_image_first, FALSE, FALSE, NULL, N_("first image") }, + { NULL, "--last", gr_image_last, FALSE, FALSE, NULL, N_("last image") }, + { "-f", "--fullscreen", gr_fullscreen_toggle, FALSE, TRUE, NULL, N_("toggle full screen") }, + { "-fs","--fullscreen-start", gr_fullscreen_start, FALSE, FALSE, NULL, N_("start full screen") }, + { "-fS","--fullscreen-stop", gr_fullscreen_stop, FALSE, FALSE, NULL, N_("stop full screen") }, + { "-s", "--slideshow", gr_slideshow_toggle, FALSE, TRUE, NULL, N_("toggle slide show") }, + { "-ss","--slideshow-start", gr_slideshow_start, FALSE, FALSE, NULL, N_("start slide show") }, + { "-sS","--slideshow-stop", gr_slideshow_stop, FALSE, FALSE, NULL, N_("stop slide show") }, + { NULL, "--slideshow-recurse:", gr_slideshow_start_rec, TRUE, FALSE, N_("<FOLDER>"), N_("start recursive slide show in FOLDER") }, + { "-d", "--delay=", gr_slideshow_delay, TRUE, FALSE, N_("<[N][.M]>"), N_("set slide show delay to N.M seconds") }, + { "+t", "--tools-show", gr_tools_show, FALSE, TRUE, NULL, N_("show tools") }, + { "-t", "--tools-hide", gr_tools_hide, FALSE, TRUE, NULL, N_("hide tools") }, + { "-q", "--quit", gr_quit, FALSE, FALSE, NULL, N_("quit") }, + { NULL, "--config-load:", gr_config_load, TRUE, FALSE, N_("<FILE>"), N_("load configuration from FILE") }, + { NULL, "--get-sidecars:", gr_get_sidecars, TRUE, FALSE, N_("<FILE>"), N_("get list of sidecars of FILE") }, + { NULL, "--get-destination:", gr_get_destination, TRUE, FALSE, N_("<FILE>"), N_("get destination path of FILE") }, + { NULL, "file:", gr_file_load, TRUE, FALSE, N_("<FILE>"), N_("open FILE") }, + { NULL, "view:", gr_file_view, TRUE, FALSE, N_("<FILE>"), N_("open FILE in new window") }, + { NULL, "--list-clear", gr_list_clear, FALSE, FALSE, NULL, N_("clear command line collection list") }, + { NULL, "--list-add:", gr_list_add, TRUE, FALSE, N_("<FILE>"), N_("add FILE to command line collection list") }, + { NULL, "raise", gr_raise, FALSE, FALSE, NULL, N_("bring the Geeqie window to the top") }, { NULL, NULL, NULL, FALSE, FALSE, NULL } }; @@ -720,6 +721,8 @@ static void remote_cb(RemoteConnection *rc, const gchar *text, GIOChannel *chann void remote_help(void) { gint i; + gchar *s_opt_param; + gchar *l_opt_param; print_term(_("Remote command list:\n")); @@ -728,11 +731,15 @@ void remote_help(void) { if (remote_commands[i].description) { - printf_term(" %-3s%s %-20s %s\n", - (remote_commands[i].opt_s) ? remote_commands[i].opt_s : "", + s_opt_param = g_strconcat(remote_commands[i].opt_s, remote_commands[i].parameter, NULL); + l_opt_param = g_strconcat(remote_commands[i].opt_l, remote_commands[i].parameter, NULL); + printf_term(" %-11s%-1s %-30s%-s\n", + (remote_commands[i].opt_s) ? s_opt_param : "", (remote_commands[i].opt_s && remote_commands[i].opt_l) ? "," : " ", - (remote_commands[i].opt_l) ? remote_commands[i].opt_l : "", + (remote_commands[i].opt_l) ? l_opt_param : "", _(remote_commands[i].description)); + g_free(s_opt_param); + g_free(l_opt_param); } i++; } -- 2.20.1