Commit a0e9a69e authored by Pino Toscano's avatar Pino Toscano
Browse files

doc: remove CLI chapter from user documentation

The description of the command line interface belongs more to the man
page. Because of this, add to the man page all the useful bits related
to the command line interface previously in the user documentation.
parent dfdb60b7
......@@ -2266,60 +2266,6 @@ For more information about this constants see the documentation of GSL.
</chapter>
<chapter id="command-line-options">
<title>Command Line Options</title>
<sect1 id="specify-a-file">
<title>Specify a File</title>
<para>
When starting &LabPlot; from the command prompt, you can supply the name of a project file (ending with .lml, .lml.gz, .lml.bz2 or .lml.xz):
<cmdsynopsis>
<command>labplot2</command>
<arg rep="repeat"><replaceable>file.lml</replaceable></arg>
</cmdsynopsis>
</para>
</sect1>
<sect1 id="other-command-line-options">
<title>Other Command Line Options</title>
<para>The following command line help options are available</para>
<variablelist>
<varlistentry>
<term><command>labplot2 <option>--help</option></command></term>
<listitem><para>This lists the most basic options available at the
command line.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>labplot2 <option>--no-splash</option></command></term>
<listitem><para>Do not show the splash screen</para></listitem>
</varlistentry>
<varlistentry>
<term><command>labplot2 <option>--presenter</option></command></term>
<listitem><para>Start in the presenter mode</para></listitem>
</varlistentry>
<varlistentry>
<term><command>labplot2 <option>--author</option></command></term>
<listitem><para>Lists &LabPlot;'s author in the terminal window</para></listitem>
</varlistentry>
<varlistentry>
<term><command>labplot2 <option>--version</option></command></term>
<listitem><para>Lists version information for &LabPlot;.
Also available through <command>labplot2 <option>-v</option></command>
</para></listitem>
</varlistentry>
</variablelist>
</sect1>
</chapter>
<chapter id="faq">
<title>Questions and Answers</title>
......
......@@ -28,7 +28,7 @@
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
<command>labplot2</command>
<arg choice="opt"><replaceable>generic-options</replaceable></arg>
<arg choice="opt"><replaceable>LabPlot options</replaceable></arg>
<arg choice="opt"><replaceable>file</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
......@@ -47,10 +47,26 @@
</refsect1>
<refsect1 id="options"><title>Options</title>
<refsect1 id="options"><title>LabPlot options</title>
<para>
For a full summary of generic options, run <userinput><command>labplot2</command> <parameter>--help</parameter></userinput>.
</para>
<variablelist>
<varlistentry>
<term><option>--no-splash</option></term>
<listitem>
<para>Do not show the splash screen.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--presenter</option></term>
<listitem>
<para>Start in the presenter mode.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="arguments"><title>Arguments</title>
......@@ -58,7 +74,8 @@
<varlistentry>
<term><option>file</option></term>
<listitem>
<para>An address of the project to be opened.</para>
<para>The location of the project to be opened, usually ending with <literal role="extension">.lml</literal>.</para>
<para>The project file can be also compressed, with its filename ending with <literal role="extension">.lml.gz</literal>, <literal role="extension">.lml.bz2</literal> or <literal role="extension">.lml.xz</literal>.</para>
</listitem>
</varlistentry>
</variablelist>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment