[blfs-book] r9507 - trunk/BOOK/general/prog

andy at linuxfromscratch.org andy at linuxfromscratch.org
Thu Feb 23 15:53:04 PST 2012


Author: andy
Date: 2012-02-23 16:53:00 -0700 (Thu, 23 Feb 2012)
New Revision: 9507

Modified:
   trunk/BOOK/general/prog/git.xml
Log:
added download links for the git man pages and html docs

Modified: trunk/BOOK/general/prog/git.xml
===================================================================
--- trunk/BOOK/general/prog/git.xml	2012-02-23 22:29:13 UTC (rev 9506)
+++ trunk/BOOK/general/prog/git.xml	2012-02-23 23:53:00 UTC (rev 9507)
@@ -66,6 +66,21 @@
       </listitem>
     </itemizedlist>
 
+    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
+    <itemizedlist spacing="compact">
+      <listitem>
+        <para><ulink
+        url="http://git-core.googlecode.com/files/git-manpages-&git-version;.2.tar.gz">Man
+        Pages</ulink> (only needed if you've not installed asciidoc)</para>
+      </listitem>
+      <listitem>
+        <para><ulink
+        url="http://git-core.googlecode.com/files/git-htmldocs-&git-version;.2.tar.gz">Html
+        version of the Man Pages</ulink> and other docs (only needed if you've
+        not installed asciidoc and xmlto).</para>
+      </listitem>
+    </itemizedlist>
+
     <bridgehead renderas="sect3">Git Dependencies</bridgehead>
 
     <bridgehead renderas="sect4">Required</bridgehead>
@@ -81,7 +96,7 @@
     repository viewer, uses <application>Tk</application> at runtime)</para>
 
     <bridgehead renderas="sect4">Optional (to create the man
-    pages)</bridgehead>
+    pages and html docs)</bridgehead>
     <para><ulink url="http://www.methods.co.nz/asciidoc/">AsciiDoc</ulink> and
     <xref linkend="xmlto"/>.</para>
 
@@ -99,11 +114,18 @@
 make</userinput></screen>
 
     <para>If you have installed <ulink
-    url="http://www.methods.co.nz/asciidoc/">AsciiDoc</ulink> and
-    <xref linkend="xmlto"/> and you wish to create the man pages:</para>
+    url="http://www.methods.co.nz/asciidoc/">AsciiDoc</ulink> and you wish to
+    create the man pages:</para>
 
 <screen><userinput>make man</userinput></screen>
 
+    <para>If you have installed <ulink
+    url="http://www.methods.co.nz/asciidoc/">AsciiDoc</ulink> and
+    <xref linkend="xmlto"/> you can create the html version of the man
+    pages and other docs:</para>
+
+<screen><userinput>make html</userinput></screen>
+
     <para>To check the results, issue: <command>make test</command>.</para>
 
     <para>Now, as the <systemitem class="username">root</systemitem>
@@ -111,9 +133,44 @@
 
 <screen role="root"><userinput>make install</userinput></screen>
 
-    <para>If you created the man pages, install them:</para>
+    <para>If you created the man pages, install them as the
+    <systemitem class="username">root</systemitem> user:</para>
 
 <screen role="root"><userinput>make install-man</userinput></screen>
+
+    <para>If you created the html docs, install them as the
+    <systemitem class="username">root</systemitem> user:</para>
+
+<screen role="root"><userinput>make htmldir=/usr/share/doc/git-&git-version; install-html &&
+mkdir -p /usr/share/doc/git-&git-version;/man-pages/{html,text} &&
+mv /usr/share/doc/git-&git-version;/{git*.txt,man-pages/text} &&
+mv /usr/share/doc/git-&git-version;/{git*.,index.,man-pages/}html &&
+mkdir /usr/share/doc/git-&git-version;/technical/{html,text} &&
+mv /usr/share/doc/git-&git-version;/technical/{*.txt,text} &&
+mv /usr/share/doc/git-&git-version;/technical/{*.,}html &&
+mkdir /usr/share/doc/git-&git-version;/howto/{html,text} &&
+mv /usr/share/doc/git-&git-version;/howto/{*.txt,text} &&
+mv /usr/share/doc/git-&git-version;/howto/{*.,}html</userinput></screen>
+
+    <para>Alternatively, If you downloaded the man pages untar them as the
+    <systemitem class="username">root</systemitem> user:</para>
+
+<screen role="root"><userinput>tar xf ../git-manpages-&git-version;.2.tar.gz -C /usr/share/man --no-same-owner</userinput></screen>
+
+    <para>If you downloaded the html docs untar them as the
+    <systemitem class="username">root</systemitem> user:</para>
+
+<screen role="root"><userinput>mkdir -p /usr/share/doc/git-&git-version;/man-pages/{html,text} &&
+tar -xf ../git-htmldocs-&git-version;.2.tar.gz \
+  -C /usr/share/doc/git-&git-version; --no-same-owner &&
+mv /usr/share/doc/git-&git-version;/{git*.txt,man-pages/text} &&
+mv /usr/share/doc/git-&git-version;/{git*.,index.,man-pages/}html &&
+mkdir /usr/share/doc/git-&git-version;/technical/{html,text} &&
+mv /usr/share/doc/git-&git-version;/technical/{*.txt,text} &&
+mv /usr/share/doc/git-&git-version;/technical/{*.,}html &&
+mkdir /usr/share/doc/git-&git-version;/howto/{html,text} &&
+mv /usr/share/doc/git-&git-version;/howto/{*.txt,text} &&
+mv /usr/share/doc/git-&git-version;/howto/{*.,}html</userinput></screen>
   </sect2>
 
   <sect2 role="commands">
@@ -122,6 +179,20 @@
     <para><option>--with-gitconfig=/etc/gitconfig</option>: This sets
     <filename>/etc/gitconfig</filename> as the file that stores the default,
     system wide, <application>Git</application> settings.</para>
+
+    <para><command>tar xf ../git-manpages-&git-version;.2.tar.gz -C
+    /usr/share/man --no-same-owner</command>: This untars
+    <filename>git-manpages-&git-version;.2.tar.gz</filename>. The
+    <option>-C</option> option makes tar change directory to
+    <filename class="directory">/usr/share/man</filename> before it starts to
+    decompress the docs. The <option>--no-same-owner</option> option stops tar
+    from preserving the user and group details of the files. This is useful as
+    that user or group may not exist on your system; this could
+    (potentially) be a security risk.</para>
+
+    <para><command>mv /usr/share/doc/git-&git-version; ...</command>: These
+    commands move some of the files into subfolders to make it easier to sort
+    through the docs and find what you're looking for.</para>
   </sect2>
 
   <sect2 role="configuration">
@@ -165,8 +236,9 @@
       <seglistitem>
         <seg>git, git-cvsserver, gitk, git-receive-pack, git-shell,
         git-upload-archive and git-upload-pack.</seg>
-        <seg>/usr/libexec/git-core, /usr/share/git-core, /usr/share/git-gui,
-        /usr/share/gitk and /usr/share/gitweb</seg>
+        <seg>/usr/libexec/git-core, /usr/share/git-&git-version;,
+        /usr/share/git-core, /usr/share/git-gui, /usr/share/gitk and
+        /usr/share/gitweb</seg>
       </seglistitem>
     </segmentedlist>
 




More information about the blfs-book mailing list