[glib: 1/6] docs: Improve formatting of literals in gio documentation

[Philip Withnall <pwithnall src gnome org>]

commit 7bac53d41f9546ac17a5550093c158f91c993222
Author: Philip Withnall <withnall endlessm com>
Date:   Wed Dec 19 12:16:48 2018 +0000

    docs: Improve formatting of literals in gio documentation
    
    There was no distinction between literals which need to be typed, and
    normal words in the prose.
    
    Signed-off-by: Philip Withnall <withnall endlessm com>

 docs/reference/gio/gio.xml | 64 ++++++++++++++++++++++++----------------------
 1 file changed, 33 insertions(+), 31 deletions(-)
---
diff --git a/docs/reference/gio/gio.xml b/docs/reference/gio/gio.xml
index c348c43e5..71096dac6 100644
--- a/docs/reference/gio/gio.xml
+++ b/docs/reference/gio/gio.xml
@@ -178,9 +178,9 @@
         <listitem>
           <para>Concatenates the given files and prints them to the standard
             output.</para>
-          <para>The cat command works just like the traditional cat utility.</para>
-          <para>Note: just pipe through cat if you need its formatting options
-            like -n, -T or other.</para>
+          <para>The <command>cat</command> command works just like the traditional <command>cat</command> 
utility.</para>
+          <para>Note: just pipe through <command>cat</command> if you need its formatting options
+            like <option>-n</option>, <option>-T</option> or other.</para>
         </listitem>
       </varlistentry>
 
@@ -195,7 +195,7 @@
           <para>Copies one or more files from <replaceable>SOURCE</replaceable>
             to <replaceable>DESTINATION</replaceable>. If more than one source
             is specified, the destination must be a directory.</para>
-          <para>The copy command is similar to the traditional cp utility.</para>
+          <para>The <command>copy</command> command is similar to the traditional <command>cp</command> 
utility.</para>
           <refsect3>
             <title>Options</title>
             <variablelist>
@@ -235,7 +235,7 @@
         </term>
         <listitem>
           <para>Shows information about the given locations.</para>
-          <para>The info command is similar to the traditional ls utility.</para>
+          <para>The <command>info</command> command is similar to the traditional <command>ls</command> 
utility.</para>
           <refsect3>
             <title>Options</title>
             <variablelist>
@@ -252,7 +252,7 @@
                 <term><option>-a</option> 
<option>--attributes=<replaceable>ATTRIBUTES</replaceable></option></term>
                 <listitem><para>The attributes to get.</para>
                   <para>Attributes can be specified with their GIO name, e.g.
-                    standard::icon, or just by namespace, e.g. unix, or by '*',
+                    <literal>standard::icon</literal>, or just by namespace, e.g. <literal>unix</literal>, 
or by <literal>*</literal>,
                     which matches all attributes. Several attributes or groups
                     of attributes can be specified, separated by comma.</para>
                   <para>By default, all attributes are listed.</para></listitem>
@@ -275,7 +275,7 @@
         <listitem>
           <para>Lists the contents of the given locations. If no location is
             given, the contents of the current directory are shown.</para>
-          <para>The list command is similar to the traditional ls utility.</para>
+          <para>The <command>list</command> command is similar to the traditional <command>ls</command> 
utility.</para>
           <refsect3>
             <title>Options</title>
             <variablelist>
@@ -283,7 +283,7 @@
                 <term><option>-a</option> 
<option>--attributes=<replaceable>ATTRIBUTES</replaceable></option></term>
                 <listitem><para>The attributes to get.</para>
                   <para>Attributes can be specified with their GIO name, e.g.
-                    standard::icon, or just by namespace, e.g. unix, or by '*',
+                    <literal>standard::icon</literal>, or just by namespace, e.g. <literal>unix</literal>, 
or by <literal>*</literal>,
                     which matches all attributes. Several attributes or groups
                     of attributes can be specified, separated by comma.</para>
                   <para>By default, all attributes are listed.</para></listitem>
@@ -316,12 +316,12 @@
           <arg choice="opt"><replaceable>HANDLER</replaceable></arg>
         </term>
         <listitem>
-          <para>If no handler is given, the mime command lists the
+          <para>If no handler is given, the <command>mime</command> command lists the
             registered and recommended applications for the mimetype.
             If a handler is given, it is set as the default handler for
             the mimetype.</para>
           <para>Handlers must be specified by their desktop file name,
-            including the extension. Example: org.gnome.gedit.desktop.</para>
+            including the extension. Example: <literal>org.gnome.gedit.desktop</literal>.</para>
         </listitem>
       </varlistentry>
 
@@ -333,7 +333,7 @@
         </term>
         <listitem>
           <para>Creates directories.</para>
-          <para>The mkdir command is similar to the traditional mkdir utility.</para>
+          <para>The <command>mkdir</command> command is similar to the traditional <command>mkdir</command> 
utility.</para>
           <refsect3>
             <title>Options</title>
             <variablelist>
@@ -356,7 +356,7 @@
           <para>Monitors files or directories for changes, such as creation
             deletion, content and attribute changes, and mount and unmount
             operations affecting the monitored locations.</para>
-          <para>The monitor command uses the GIO file monitoring APIs to do
+          <para>The <command>monitor</command> command uses the GIO file monitoring APIs to do
             its job. GIO has different implementations for different platforms.
             The most common implementation on Linux uses inotify.</para>
           <refsect3>
@@ -400,15 +400,15 @@
           <arg choice="opt" rep="repeat"><replaceable>LOCATION</replaceable></arg>
         </term>
         <listitem>
-          <para>Provides commandline access to various aspects of GIOs mounting
+          <para>Provides commandline access to various aspects of GIO’s mounting
             functionality.</para>
           <para>Mounting refers to the traditional concept of arranging multiple
-            file systems and devices in a single tree, rooted at /. Classical
+            file systems and devices in a single tree, rooted at <filename>/</filename>. Classical
             mounting happens in the kernel and is controlle by the mount utility.
             GIO expands this concept by introducing mount daemons that can make
             file systems available to GIO applications without kernel
             involvement.</para>
-          <para>GIO mounts can require authentication, and the mount command
+          <para>GIO mounts can require authentication, and the <command>mount</command> command
             may ask for user IDs, passwords, and so on, when required.</para>
           <refsect3>
             <title>Options</title>
@@ -486,7 +486,7 @@
           <para>Moves one or more files from <replaceable>SOURCE</replaceable>
             to <replaceable>DESTINATION</replaceable>. If more than one source
             is specified, the destination must be a directory.</para>
-          <para>The move command is similar to the traditional mv utility.</para>
+          <para>The <command>move</command> command is similar to the traditional <command>mv</command> 
utility.</para>
         </listitem>
       </varlistentry>
 
@@ -501,7 +501,7 @@
           <para>GIO obtains this information from the shared-mime-info
             database, with per-user overrides stored in
             <filename><envar>$XDG_DATA_HOME</envar>/applications/mimeapps.list</filename>.</para>
-          <para>The mime command can be used to change the default handler for
+          <para>The <command>mime</command> command can be used to change the default handler for
             a mimetype.</para>
         </listitem>
       </varlistentry>
@@ -514,7 +514,7 @@
         </term>
         <listitem>
           <para>Renames a file.</para>
-          <para>The rename command is similar to the traditional rename utility.</para>
+          <para>The <command>rename</command> command is similar to the traditional 
<command>rename</command> utility.</para>
         </listitem>
       </varlistentry>
 
@@ -527,10 +527,10 @@
         <listitem>
           <para>Deletes each given file.</para>
           <para>This command removes files irreversibly. If you want a reversible
-            way to remove files, see the trash command.</para>
+            way to remove files, see the <command>trash</command> command.</para>
           <para>Note that not all URI schemes that are supported by GIO may
             allow deletion of files.</para>
-          <para> The remove command is similar to the traditional rm utility.</para>
+          <para>The <command>remove</command> command is similar to the traditional <command>rm</command> 
utility.</para>
           <refsect3>
             <title>Options</title>
             <variablelist>
@@ -553,7 +553,7 @@
           <para>Reads from standard input and saves the data to the given
             location.</para>
           <para>This is similar to just redirecting output to a file using
-            traditional shell syntax, but the save command allows saving to
+            traditional shell syntax, but the <command>save</command> command allows saving to
             location that GIO can write to.</para>
           <refsect3>
             <title>Options</title>
@@ -601,21 +601,23 @@
         <listitem>
           <para>Sets a file attribute on a file.</para>
           <para>File attributes can be specified with their GIO name, e.g
-            standard::icon. Note that not all GIO file attributes are writable.
-            Use the --query-writable option of the info command to list
+            <literal>standard::icon</literal>. Note that not all GIO file attributes are writable.
+            Use the <option>--query-writable</option> option of the <command>info</command> command to list
             writable file attributes.</para>
           <para>If the <replaceable>TYPE</replaceable> is unset,
             <replaceable>VALUE</replaceable> does not have to be specified.
-            If the type is stringv, multiple values can be given.</para>
+            If the <replaceable>TYPE</replaceable> is <literal>stringv</literal>, multiple values can be 
given.</para>
           <refsect3>
             <title>Options</title>
             <variablelist>
               <varlistentry>
                 <term><option>-t</option>, <option>--type=<replaceable>TYPE</replaceable></option></term>
                 <listitem><para>Specifies the type of the attribute. Supported
-                  types are string, stringv, bytestring, boolean, uint32, int32,
-                  uint64, int64 and unset.</para>
-                  <para>If the type is not specified, string is assumed.</para>
+                  types are <literal>string</literal>, <literal>stringv</literal>,
+                  <literal>bytestring</literal>, <literal>boolean</literal>,
+                  <literal>uint32</literal>, <literal>int32</literal>,
+                  <literal>uint64</literal>, <literal>int64</literal> and <literal>unset</literal>.</para>
+                  <para>If the type is not specified, <literal>string</literal> is assumed.</para>
                 </listitem>
               </varlistentry>
               <varlistentry>
@@ -641,10 +643,10 @@
             <filename><envar>$XDG_DATA_HOME</envar>/Trash</filename>.</para>
           <para>Note that moving files to the trash does not free up space on
             the file system until the "Trashcan" is emptied. If you are interested
-            in deleting a file irreversibly, see the remove command.</para>
+            in deleting a file irreversibly, see the <command>remove</command> command.</para>
           <para>Inspecting and emptying the "Trashcan" is normally supported by
-            graphical file managers such as nautilus, but you can also see the
-            trash with the command: gio list trash://.</para>
+            graphical file managers such as Nautilus, but you can also see the
+            trash with the command: <command>gio list trash://</command>.</para>
           <refsect3>
             <title>Options</title>
             <variablelist>
@@ -671,7 +673,7 @@
           <para>Lists the contents of the given locations recursively, in a
             tree-like format. If no location is given, it defaults to the current
             directory.</para>
-          <para>The tree command is similar to the traditional tree utility.</para>
+          <para>The <command>tree</command> command is similar to the traditional <command>tree</command> 
utility.</para>
           <refsect3>
             <title>Options</title>
             <variablelist>