[Xfce4-commits] <terminal:nick/man> Move the environment and files sections to the man page.

Nick Schermer noreply at xfce.org
Thu Dec 10 15:10:06 CET 2009


Updating branch refs/heads/nick/man
         to ccc905e6b5ac542b4af1b7a97eb00978e54e1314 (commit)
       from eb9de4c7bbd014d1df4a86e01c58845c773151b8 (commit)

commit ccc905e6b5ac542b4af1b7a97eb00978e54e1314
Author: Nick Schermer <nick at xfce.org>
Date:   Thu Dec 10 14:05:22 2009 +0100

    Move the environment and files sections to the man page.
    
    The generated HTML does not change, because the sections
    are included in the manual xml file.

 doc/Terminal.1.xml |   86 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 doc/Terminal.xml   |   79 ++++--------------------------------------------
 2 files changed, 92 insertions(+), 73 deletions(-)

diff --git a/doc/Terminal.1.xml b/doc/Terminal.1.xml
index 05b42fe..f7cff14 100644
--- a/doc/Terminal.1.xml
+++ b/doc/Terminal.1.xml
@@ -440,6 +440,92 @@
     </variablelist>
   </refsect1>
 
+  <refsect1 id="environment">
+    <title>Environment</title>
+
+    <para>
+      Terminal uses the Basedir Specification as defined on
+      <ulink url="http://freedesktop.org/" type="http">Freedesktop.org</ulink> to locate its
+      data and configuration files. This means that file locations will be specified as
+      a path relative to the directories described in the specification.
+    </para>
+
+    <variablelist>
+      <varlistentry>
+        <term><varname>${XDG_CONFIG_HOME}</varname></term>
+        <listitem>
+          <para>
+            The first base directory to look for configuration
+            files. By default this is set to <filename role="directory">~/.config/</filename>.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><varname>${XDG_CONFIG_DIRS}</varname></term>
+        <listitem>
+          <para>
+            A colon separated list of base directories that contain configuration
+            data. By default the application will look in <filename role="directory">${sysconfdir}/xdg/</filename>.
+            The value of <varname>${sysconfdir}</varname> depends on how the program was
+            build and will often be <filename role="directory">/etc/</filename>
+            for binary packages.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><varname>${XDG_DATA_HOME}</varname></term>
+        <listitem>
+          <para>
+            The root for all user-specific data files. By default this
+            is set to <filename role="directory">~/.local/share/</filename>.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><varname>${XDG_DATA_DIRS}</varname></term>
+        <listitem>
+          <para>
+            A set of preference ordered base directories relative to which
+            data files should be searched in addition to the
+            <varname>${XDG_DATA_HOME}</varname> base directory. The directories
+            should be separated with a colon.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
+  <refsect1 id="files">
+    <title>Files</title>
+
+    <variablelist>
+      <varlistentry>
+        <term><filename>${XDG_CONFIG_DIRS}/Terminal/terminalrc</filename></term>
+        <listitem>
+          <para>
+            This is the location of the configuration file that includes the
+            preferences which control the look and feel of &application;.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><filename>${XDG_DATA_DIRS}/Terminal/Terminal-toolbars.ui</filename></term>
+        <listitem>
+          <para>
+            This file includes the user interface definition for the toolbars. If
+            you customize the toolbars using the graphical toolbars editor, &application;
+            will store the new toolbars layout in the file
+            <filename>${XDG_DATA_HOME}/Terminal/Terminal-toolbars.ui</filename>.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
   <refsect1 id="seealso">
     <title>See also</title>
     <para>
diff --git a/doc/Terminal.xml b/doc/Terminal.xml
index 2600763..61e2e81 100644
--- a/doc/Terminal.xml
+++ b/doc/Terminal.xml
@@ -1062,80 +1062,13 @@
     <sect2 id="files-and-env-vars">
       <title>Files and Environment Variables</title>
 
-      <para>
-        Terminal uses the Basedir Specification as defined on <ulink url="http://freedesktop.org/" type="http">Freedesktop.org</ulink> to locate its data and configuration files. This means
-        that file locations will be specified as a path relative to the directories described in
-        the specification.
-      </para>
-
-      <variablelist>
-        <varlistentry>
-          <term><varname>${XDG_CONFIG_HOME}</varname></term>
-          <listitem>
-            <para>
-              The first base directory to look for configuration
-              files. By default this is set to <filename role="directory">~/.config/</filename>.
-            </para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
-          <term><varname>${XDG_CONFIG_DIRS}</varname></term>
-          <listitem>
-            <para>
-              A colon separated list of base directories that contain configuration
-              data. By default the application will look in <filename role="directory">${sysconfdir}/xdg/</filename>. The value of
-              <varname>${sysconfdir}</varname> depends on how the program was
-              build and will often be <filename role="directory">/etc/</filename>
-              for binary packages.
-            </para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
-          <term><varname>${XDG_DATA_HOME}</varname></term>
-          <listitem>
-            <para>
-              The root for all user-specific data files. By default this
-              is set to <filename role="directory">~/.local/share/</filename>.
-            </para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
-          <term><varname>${XDG_DATA_DIRS}</varname></term>
-          <listitem>
-            <para>
-              A set of preference ordered base directories relative to which
-              data files should be searched in addition to the
-              <varname>${XDG_DATA_HOME}</varname> base directory. The directories
-              should be separated with a colon.
-            </para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
-          <term><filename>${XDG_CONFIG_DIRS}/Terminal/terminalrc</filename></term>
-          <listitem>
-            <para>
-              This is the location of the configuration file that includes the
-              preferences which control the look and feel of &application;.
-            </para>
-          </listitem>
-        </varlistentry>
+      <xi:include href="Terminal-options.xml"
+                xmlns:xi="http://www.w3.org/2001/XInclude"
+                xpointer="xpointer(//sect1[@id='environment']/title/following-sibling::*)"/>
 
-        <varlistentry>
-          <term><filename>${XDG_DATA_DIRS}/Terminal/Terminal-toolbars.ui</filename></term>
-          <listitem>
-            <para>
-              This file includes the user interface definition for the toolbars. If
-              you customize the toolbars using the graphical toolbars editor, &application;
-              will store the new toolbars layout in the file
-              <filename>${XDG_DATA_HOME}/Terminal/Terminal-toolbars.ui</filename>.
-            </para>
-          </listitem>
-        </varlistentry>
-      </variablelist>
+      <xi:include href="Terminal-options.xml"
+                xmlns:xi="http://www.w3.org/2001/XInclude"
+                xpointer="xpointer(//sect1[@id='files']/title/following-sibling::*)"/>
     </sect2>
 
     <sect2 id="hidden-options">



More information about the Xfce4-commits mailing list