Git commit 12465f6f882408e6f13d25e8d763563e171f6721 by Robby Stephenson. Committed on 14/03/2024 at 14:59. Pushed by rstephenson into branch 'master'.
Update doc info for logging option M +3 -1 doc/advanced.docbook M +14 -2 doc/menus.docbook https://invent.kde.org/office/tellico/-/commit/12465f6f882408e6f13d25e8d763563e171f6721 diff --git a/doc/advanced.docbook b/doc/advanced.docbook index d901d5c6..4619fc32 100644 --- a/doc/advanced.docbook +++ b/doc/advanced.docbook @@ -5,7 +5,7 @@ <title>Command Line Options</title> <para> -When running &appname; from the command line, there are several options for opening data files. They may be seen by running <userinput>tellico --help</userinput>. +When running &appname; from the command line, there are several options for opening data files. They may be seen by running <userinput>tellico --help</userinput>. Diagnostic logging can also be enabled, which will make a <link linkend="settings-help-menu">menu item</link> to show the diagnostic log. The <userinput>--logfile</userinput> option redirects the log to a file. </para> <programlisting> @@ -19,6 +19,8 @@ Options: --mods Import <filename> as a MODS file --ris Import <filename> as a RIS file --pdf Import <filename> as a PDF file + --log Log diagnostic output + --logfile <logfile> Write log output to <filename> Arguments: [filename] File to open diff --git a/doc/menus.docbook b/doc/menus.docbook index 071b80ab..02d9e029 100644 --- a/doc/menus.docbook +++ b/doc/menus.docbook @@ -595,7 +595,7 @@ source and <action>update the selected entries</action>.</para> </sect2> <!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%% SETTINGS / HELP MENU %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%--> -<sect2> +<sect2 id="settings-help-menu"> <title>The Settings and Help Menu</title> <para>Apart from the common &kde; Settings and Help menus described in the <ulink url="help:/fundamentals/menus.html">Menu</ulink> @@ -656,7 +656,6 @@ chapter of the &kde; Fundamentals documentation &tellico; has these application </listitem> </varlistentry> - <varlistentry> <term> <menuchoice> @@ -670,6 +669,19 @@ chapter of the &kde; Fundamentals documentation &tellico; has these application </listitem> </varlistentry> +<varlistentry> + <term> + <menuchoice> + <guimenu>Help</guimenu> + <guimenuitem>Show Log</guimenuitem> + </menuchoice> + </term> + + <listitem> + <para>When the <userinput>tellico --log</userinput> option is used, this command shows the diagnostic log.</para> + </listitem> +</varlistentry> + </variablelist> </sect2>