tdf#100836 "Starting the LibreOffice Software With Parameters" help update

rewritten cmdHelp in accordance with the attached document in bug tdf#100836

Change-Id: I6453ee87039272388fe1bc0efd747dc706b570ff
Reviewed-on: https://gerrit.libreoffice.org/31244
Reviewed-by: Mike Kaganski <mike.kaganski@collabora.com>
Tested-by: Mike Kaganski <mike.kaganski@collabora.com>

1 files changed, 124 insertions, 69 deletions

diff --git a/desktop/source/app/cmdlinehelp.cxx b/desktop/source/app/cmdlinehelp.cxx
index 122238c9ef81..915f060c5caa 100644
--- a/desktop/source/app/cmdlinehelp.cxx
+++ b/desktop/source/app/cmdlinehelp.cxx
@@ -38,75 +38,130 @@ namespace desktop
         "%PRODUCTNAME %PRODUCTVERSION%PRODUCTEXTENSION %BUILDID\n"
         "\n";
     const char aCmdLineHelp[] =
-        "Usage: %CMDNAME [options] [documents...]\n"
-        "\n"
-        "Options:\n"
-        "--minimized    keep startup bitmap minimized.\n"
-        "--invisible    no startup screen, no default document and no UI.\n"
-        "--norestore    suppress restart/restore after fatal errors.\n"
-        "--quickstart   starts the quickstart service\n"
-        "--safe-mode    starts the safe mode\n"
-        "--nologo       don't show startup screen.\n"
-        "--nolockcheck  don't check for remote instances using the installation\n"
-        "--nodefault    don't start with an empty document\n"
-        "--headless     like invisible but no user interaction at all.\n"
-        "--help/-h/-?   show this message and exit.\n"
-        "--version      display the version information.\n"
-        "--writer       create new text document.\n"
-        "--calc         create new spreadsheet document.\n"
-        "--draw         create new drawing.\n"
-        "--impress      create new presentation.\n"
-        "--base         create new database.\n"
-        "--math         create new formula.\n"
-        "--global       create new global document.\n"
-        "--web          create new HTML document.\n"
-        "-o             open documents regardless whether they are templates or not.\n"
-        "-n             always open documents as new files (use as template).\n"
-        "--display <display>\n"
-        "      Specify X-Display to use in Unix/X11 versions.\n"
-        "-p <documents...>\n"
-        "      print the specified documents on the default printer.\n"
-        "--pt <printer> <documents...>\n"
-        "      print the specified documents on the specified printer.\n"
-        "--view <documents...>\n"
-        "      open the specified documents in viewer-(readonly-)mode.\n"
-        "--show <presentation>\n"
-        "      open the specified presentation and start it immediately\n"
-        "--language=<language_tag>\n"
-        "      Override the UI language with the given locale\n"
-        "      Eg. --language=fr\n"
-        "--accept=<accept-string>\n"
-        "      Specify an UNO connect-string to create an UNO acceptor through which\n"
-        "      other programs can connect to access the API\n"
-        "--unaccept=<accept-string>\n"
-        "      Close an acceptor that was created with --accept=<accept-string>\n"
-        "      Use --unnaccept=all to close all open acceptors\n"
-        "--infilter=<filter>[:filter_options]\n"
-        "      Force an input filter type if possible\n"
-        "      Eg. --infilter=\"Calc Office Open XML\"\n"
-        "          --infilter=\"Text (encoded):UTF8,LF,,,\"\n"
-        "--convert-to output_file_extension[:output_filter_name[:output_filter_options]] [--outdir output_dir] files\n"
-        "      Batch convert files (implies --headless).\n"
-        "      If --outdir is not specified then current working dir is used as output_dir.\n"
-        "      Eg. --convert-to pdf *.doc\n"
-        "          --convert-to pdf:writer_pdf_Export --outdir /home/user *.doc\n"
-        "          --convert-to \"html:XHTML Writer File:UTF8\" *.doc\n"
-        "          --convert-to \"txt:Text (encoded):UTF8\" *.doc\n"
-        "--print-to-file [-printer-name printer_name] [--outdir output_dir] files\n"
-        "      Batch print files to file.\n"
-        "      If --outdir is not specified then current working dir is used as output_dir.\n"
-        "      Eg. --print-to-file *.doc\n"
-        "          --print-to-file --printer-name nasty_lowres_printer --outdir /home/user *.doc\n"
-        "--cat files\n"
-        "      Dump text content of the files to console\n"
-        "      Eg. --cat *.odt\n"
-        "--pidfile=file\n"
-        "      Store soffice.bin pid to file.\n"
-        "-env:<VAR>[=<VALUE>]\n"
-        "      Set a bootstrap variable.\n"
-        "      Eg. -env:UserInstallation=file:///tmp/test to set a non-default user profile path.\n"
-        "\nRemaining arguments will be treated as filenames or URLs of documents to open.\n\n";
-
+        "Usage: %CMDNAME [argument...]\n"
+        "       argument - switches, switch parameters and document URIs (filenames).\n\n"
+        "Getting help and information:\n"
+        "   --help | -h | -?    Shows this help and quits.\n"
+        "   --helpwriter        Opens built-in or online Help on Writer.\n"
+        "   --helpcalc          Opens built-in or online Help on Calc.\n"
+        "   --helpdraw          Opens built-in or online Help on Draw.\n"
+        "   --helpimpress       Opens built-in or online Help on Impress.\n"
+        "   --helpbase          Opens built-in or online Help on Base.\n"
+        "   --helpbasic         Opens built-in or online Help on Basic scripting\n"
+        "                       language.\n"
+        "   --helpmath          Opens built-in or online Help on Math.\n"
+        "   --version           Shows the version and quits.\n"
+        "   --nstemporarydirectory\n"
+        "                       (MacOS X sandbox only) Returns path of the temporary\n"
+        "                       directory for the current user and exits. Overrides\n"
+        "                       all other arguments.\n\n"
+        "General arguments:\n"
+        "   --quickstart[=no]   Activates[Deactivates] the Quickstarter service.\n"
+        "   --nolockcheck       Disables check for remote instances using one\n"
+        "                       installation.\n"
+        "   --infilter={filter} Force an input filter type if possible. For example:\n"
+        "                       --infilter=\"Calc Office Open XML\"\n"
+        "                       --infilter=\"Text (encoded):UTF8,LF,,,\"\n"
+        "   --pidfile={file}    Store soffice.bin pid to {file}.\n"
+        "   --display {display} Sets the DISPLAY environment variable on UNIX-like\n"
+        "                       platforms to the value {display} (only supported by a\n"
+        "                       start script).\n\n"
+        "User/programmatic interface control:\n"
+        "   --nologo            Disables the splash screen at program start.\n"
+        "   --minimized         Starts minimized. The splash screen is not displayed.\n"
+        "   --nodefault         Starts without displaying anything except the splash\n"
+        "                       screen (do not display initial window).\n"
+        "   --invisible         Starts in invisible mode. Neither the start-up logo nor\n"
+        "                       the initial program window will be visible. Application\n"
+        "                       can be controlled, and documents and dialogs can be\n"
+        "                       controlled and opened via the API. Using the parameter,\n"
+        "                       the process can only be ended using the taskmanager\n"
+        "                       (Windows) or the kill command (UNIX-like systems). It\n"
+        "                       cannot be used in conjunction with --quickstart.\n"
+        "   --headless          Starts in \"headless mode\" which allows using the\n"
+        "                       application without GUI. This special mode can be used\n"
+        "                       when the application is controlled by external clients\n"
+        "                       via the API.\n"
+        "   --norestore         Disables restart and file recovery after a system crash.\n"
+        "   --safe-mode         Starts in a safe mode, i.e. starts temporarily with a\n"
+        "                       fresh user profile and helps to restore a broken\n"
+        "                       configuration.\n"
+        "   --accept={UNO-URL}  Specifies an UNO-URL connect-string to create an UNO\n"
+        "                       acceptor through which other programs can connect to\n"
+        "                       access the API. UNO-URL is string the such kind\n"
+        "                   uno:connection-type,params;protocol-name,params;ObjectName.\n"
+        "   --unaccept={UNO-URL} Closes an acceptor that was created with --accept. Use\n"
+        "                       --unaccept=all to close all open acceptors.\n"
+        "   --language={lang}   Uses specified language, if language is not selected\n"
+        "                       yet for UI. The lang is a tag of the language in IETF\n"
+        "                       language tag.\n\n"
+        "Developer arguments:\n"
+        "   --terminate_after_init\n"
+        "                       Exit after initialization complete (no documents loaded).\n"
+        "   --eventtesting      Exit after loading documents.\n\n"
+        "New document creation arguments:\n"
+        "The arguments create an empty document of specified kind. Only one of them may\n"
+        "be used in one command line. If filenames are specified after an argument,\n"
+        "then it tries to open those files in the specified component.\n"
+        "   --writer            Creates an empty Writer document.\n"
+        "   --calc              Creates an empty Calc document.\n"
+        "   --draw              Creates an empty Draw document.\n"
+        "   --impress           Creates an empty Impress document.\n"
+        "   --base              Creates a new database.\n"
+        "   --global            Creates an empty Writer master (global) document.\n"
+        "   --math              Creates an empty Math document (formula).\n"
+        "   --web               Creates an empty HTML document.\n\n"
+        "File open arguments:\n"
+        "The arguments define how following filenames are treated. New treatment begins\n"
+        "after the argument and ends at the next argument. The default treatment is to\n"
+        "open documents for editing, and create new documents from document templates.\n"
+        "   -n                  Treats following files as templates for creation of new\n"
+        "                       documents.\n"
+        "   -o                  Opens following files for editing, regardless whether\n"
+        "                       they are templates or not.\n"
+        "   --pt {Printername}  Prints following files to the printer {Printername},\n"
+        "                       after which those files are closed. The splash screen\n"
+        "                       does not appear. If used multiple times, only last\n"
+        "                       {Printername} is effective for all documents of all\n"
+        "                       --pt runs. Also, --printer-name argument of\n"
+        "                       --print-to-file switch interferes with {Printername}.\n"
+        "   -p                  Prints following files to the default printer, after\n"
+        "                       which those files are closed. The splash screen does\n"
+        "                       not appear. If the file name contains spaces, then it\n"
+        "                       must be enclosed in quotation marks.\n"
+        "   --view              Opens following files in viewer mode (read-only).\n"
+        "   --show              Opens and starts the following presentation documents \n"
+        "                       of each immediately. Files are closed after the showing.\n"
+        "                       Files other than Impress documents are opened in\n"
+        "                       default mode , regardless of previous mode.\n"
+        "   --convert-to OutputFileExtension[:OutputFilterName] [--outdir output_dir]\n"
+        "                       Batch convert files (implies --headless). If --outdir\n"
+        "                       isn't specified, then current working directory is used\n"
+        "                       as output_dir. If --convert-to is used more than once,\n"
+        "                       last value of OutputFileExtension[:OutputFilterName] is\n"
+        "                       effective. If --outdir is used more than once, only its\n"
+        "                       last value is effective. For example:\n"
+        "                   --convert-to pdf *.doc\n"
+        "                   --convert-to pdf:writer_pdf_Export --outdir /home/user *.doc\n"
+        "                   --convert-to \"html:XHTML Writer File:UTF8\" *.doc\n"
+        "                   --convert-to \"txt:Text (encoded):UTF8\" *.doc\n"
+        "   --print-to-file [--printer-name printer_name] [--outdir output_dir]\n"
+        "                       Batch print files to file. If --outdir is not specified,\n"
+        "                       then current working directory is used as output_dir.\n"
+        "                       If --printer-name or --outdir used multiple times, only\n"
+        "                       last value of each is effective. Also, {Printername} of\n"
+        "                       --pt switch interferes with --printer-name.\n"
+        "   --cat               Dump text content of the following files to console\n"
+        "                       (implies --headless). Cannot be used with --convert-to.\n"
+        "   -env:<VAR>[=<VALUE>] Set a bootstrap variable. For example: to set\n"
+        "                       a non-default user profile path:\n"
+        "                       -env:UserInstallation=file:///tmp/test\n\n"
+        "Ignored switches:\n"
+        "   -psn                Ignored (MacOS X only).\n"
+        "   -Embedding          Ignored (COM+ related; Windows only).\n"
+        "   --nofirststartwizard Does nothing, accepted only for backward compatibility.\n"
+        "   --protector {arg1} {arg2}\n"
+        "                       Used only in unit tests and should have two arguments.\n\n";
 #ifdef _WIN32
     namespace{
         class lcl_Console {