]> git.ipfire.org Git - thirdparty/snapper.git/commitdiff
Update manual
authorJosé Iván López González <jlopez@suse.com>
Wed, 30 Oct 2019 23:23:36 +0000 (23:23 +0000)
committerJosé Iván López González <jlopez@suse.com>
Wed, 30 Oct 2019 23:23:36 +0000 (23:23 +0000)
doc/snapper.xml.in

index 4b5d8487fac87f2f7794d94138f425efbb59150f..70e5ce2066c627e483a23d63b5449d7fd2909f11 100644 (file)
          <para>Specifies table style. Table style is identified by an integer number.</para>
        </listitem>
       </varlistentry>
+      <varlistentry>
+       <term><option>--machine-readable</option></term>
+       <listitem>
+         <para>Specifies a machine-readable output format. Possible options are csv and json.</para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
+       <term><option>--csvout</option></term>
+       <listitem>
+         <para>Sets CSV output format.</para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
+       <term><option>--jsonout</option></term>
+       <listitem>
+         <para>Sets JSON output format.</para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
+       <term><option>--separator</option></term>
+       <listitem>
+         <para>Specifies the character separator for CSV output format.</para>
+       </listitem>
+      </varlistentry>
       <varlistentry>
        <term><option>-c, --config <replaceable>name</replaceable></option></term>
        <listitem>
        <term><option>list-configs</option></term>
        <listitem>
          <para>List available configurations.</para>
+
+         <variablelist>
+           <varlistentry>
+             <term><option>--columns</option> <replaceable>columns</replaceable></term>
+             <listitem>
+               <para>Select columns to show separated by comma.</para>
+               <para>Possible columns are: config, subvolume.</para>
+             </listitem>
+           </varlistentry>
+         </variablelist>
        </listitem>
       </varlistentry>
 
        <term><option>get-config</option></term>
        <listitem>
          <para>Displays the settings of the configuration.</para>
+
+         <variablelist>
+           <varlistentry>
+             <term><option>--columns</option> <replaceable>columns</replaceable></term>
+             <listitem>
+               <para>Select columns to show separated by comma.</para>
+               <para>Possible columns are: key, value.</para>
+               <para>Columns are not selected when JSON format is used.</para>
+             </listitem>
+           </varlistentry>
+         </variablelist>
        </listitem>
       </varlistentry>
 
                <para>List snapshots from all configs accessible by the user.</para>
              </listitem>
            </varlistentry>
+           <varlistentry>
+             <term><option>--columns</option> <replaceable>columns</replaceable></term>
+             <listitem>
+               <para>Select columns to show separated by comma.</para>
+               <para>Possible columns are: config, subvolume, number, default, active,
+               date, user, used-space, cleanup, description, userdata, pre-number, post-number,
+               post-date.</para>
+             </listitem>
+           </varlistentry>
          </variablelist>
          <para>For each snapshot the output consists of several
          columns. Some need explanation:</para>