cvs commit: ALFS/docs/syntax_doc/alfs_dtd elem_link.xml elem_list.xml

jwrober at linuxfromscratch.org jwrober at linuxfromscratch.org
Sun Feb 22 19:10:34 PST 2004


jwrober     04/02/22 20:10:34

  Modified:    docs/syntax_doc/alfs_dtd elem_link.xml elem_list.xml
  Log:
  finished first pass across all elements
  
  Revision  Changes    Path
  1.6       +38 -43    ALFS/docs/syntax_doc/alfs_dtd/elem_link.xml
  
  Index: elem_link.xml
  ===================================================================
  RCS file: /home/cvsroot/ALFS/docs/syntax_doc/alfs_dtd/elem_link.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- elem_link.xml	4 Nov 2003 03:07:50 -0000	1.5
  +++ elem_link.xml	23 Feb 2004 03:10:34 -0000	1.6
  @@ -6,23 +6,21 @@
   <title>Syntax</title>
   
   <synopsis>
  -<!ELEMENT link           (option?, target+, name)>
  +<!ELEMENT link           (option?, target+, name)>
   <!ATTLIST link
             base           CDATA #IMPLIED
  -          type           CDATA #IMPLIED>
  +          type           CDATA #IMPLIED>
   </synopsis>
   
  -<para>This element occurs in the elements
  -<link linkend="elem_alfs">alfs</link>,
  -<link linkend="elem_alfs">else</link>,
  -<link linkend="elem_stage">stage</link>.
  -and <link linkend="elem_then">then</link>
  +<para>This element occurs in the elements :  
  +<xref linkend="elem_alfs"/>  |  
  +<xref linkend="elem_stage"/>
   </para>
   
  -<para>See also :
  -<link linkend="elem_option">option</link>,
  -<link linkend="elem_target">target</link>,
  -<link linkend="elem_name">name</link>.
  +<para>See also :  
  +<xref linkend="elem_option"/>  |  
  +<xref linkend="elem_target"/>  |  
  +<xref linkend="elem_name"/>
   </para>
   
   </sect2>
  @@ -30,56 +28,53 @@
   <sect2>
   <title>Description</title>
   
  -<para>The element <token>link</token> allows to create a (hard or symbolic) link.</para>
  +<para>The element <filename>link</filename> is one of the many main
  +operation elements. It allows you to create a hard or symbolic link.</para>
   
  -<para>The attribute <token>base</token> specify the directory  in which
  +<para>The sub-element <filename>target</filename> gives the name(s) of the targets.</para>
  +
  +<para>The sub-element <filename>option</filename> FILL IN HERE.</para>
  +
  +<para>The sub-element <filename>name</filename> gives the name of the link.
  +When there are several targets, this must be the name of a directory, in
  +which the links
  +to the targets will be created.</para>
  +
  +<para>The attribute <filename>base</filename> specifies the directory in which
   the link creation is performed.</para>
   
  -<para>The attribute <token>type</token> specify if the link is symbolic (the attribute
  +<para>The attribute <filename>type</filename> specifies if the link is symbolic (the attribute
   value is "symbolic" or not specified) or not (if the attribute value is "hard")</para>
   
  -<para>The following two options are supported :</para>
  +<para>The following two options are supported :</para>
   
   <itemizedlist>
   
  -<listitem>
  -<para>"force" means that the existing destination files
  -are removed.</para>
  -</listitem>
  +<listitem><para>"force" means that the existing destination files
  +are removed.</para></listitem>
   
  -<listitem>
  -<para>"no_dereference" means that if the destination is a symlink to a directory
  +<listitem><para>"no_dereference" means that if the destination is a symxref to a directory
   it will be treated as if it were a normal file (and thus will replace it if the "force"
  -option is specified).</para>
  -</listitem>
  +option is specified).</para></listitem>
   
   </itemizedlist>
   
  -<para>The sub-element <token>target</token> gives the name(s) of the targets.</para>
  -
  -<para>The sub-element <token>name</token> gives the name of the link.
  -When there are several targets, this must be the name of a directory, in which the links
  -to the targets will be created.</para>
  -
   </sect2>
   
   <sect2>
   <title>Examples</title>
   
  -<programlisting>
  -<link>
  -	<target>share/man</target>
  -	<target>share/doc</target>
  -	<target>share/info</target>
  -	<name>/usr/local</name>
  -</link>
  -</programlisting>
  -
  -<para>The equivalent bash script is :</para>
  -
  -<programlisting>echo 'Linking  share/man share/doc share/info into /usr/local'
  -ln -s  share/man share/doc share/info /usr/local
  -</programlisting>
  +<userinput><screen><link>
  +	<target>share/man</target>
  +	<target>share/doc</target>
  +	<target>share/info</target>
  +	<name>/usr/local</name>
  +</link></screen></userinput>
  +
  +<para>The equivalent bash script is :</para>
  +
  +<userinput><screen>echo 'Linking  share/man share/doc share/info into /usr/local'
  +<command>ln -s  share/man share/doc share/info /usr/local</command></screen></userinput>
   
   </sect2>
   
  
  
  
  1.6       +29 -34    ALFS/docs/syntax_doc/alfs_dtd/elem_list.xml
  
  Index: elem_list.xml
  ===================================================================
  RCS file: /home/cvsroot/ALFS/docs/syntax_doc/alfs_dtd/elem_list.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- elem_list.xml	4 Nov 2003 03:07:50 -0000	1.5
  +++ elem_list.xml	23 Feb 2004 03:10:34 -0000	1.6
  @@ -6,18 +6,17 @@
   <title>Syntax</title>
   
   <synopsis>
  -<!ELEMENT list    (item|list)+>
  +<!ELEMENT list           (item | list)+>
   <!ATTLIST list
  -          type           (bullet|number) "bullet">
  +          type           (bullet | number) "bullet">
   </synopsis>
   
  -<para>This element occurs in the elements
  -<link linkend="elem_description">description</link>
  -and <link linkend="elem_list">list</link>.
  +<para>This element occurs in the elements :  
  +<xref linkend="elem_description"/>
   </para>
   
  -<para>See also :
  -<link linkend="elem_item">item</link>.
  +<para>See also :  
  +<xref linkend="elem_item"/>
   </para>
   
   </sect2>
  @@ -25,7 +24,7 @@
   <sect2>
   <title>Description</title>
   
  -<para>The element <token>list</token> contains
  +<para>The element <filename>list</filename> contains
   a list of items or sub-lists in a description.</para>
   
   </sect2>
  @@ -33,36 +32,32 @@
   <sect2>
   <title>Examples</title>
   
  -<programlisting>
  -    <package name="gimp" version="1.2.3">
  -        <packageinfo>
  -	        <description>
  -                    <para>The gimp package contains the GNU Image
  -		    Manipulation Program.
  -		    This is useful for :</para>
  -		    <list>
  -		    <item>photo retouching,</item>
  -		    <item>image composition,</item>
  -		    <item>image authoring.</item>
  -		    </list>
  -		</description>
  -
  -                <requires><name>gtk+</name></requires>
  -
  -		<utilizes><name>libtiff</name></utilizes>
  -		<utilizes><name>libpng</name></utilizes>
  -		<utilizes><name>libjpeg</name></utilizes>
  -		<utilizes><name>aalib</name></utilizes>
  -		<utilizes><name>mpeg_lib</name></utilizes>
  -		<utilizes><name>python</name></utilizes>
  +<userinput><screen><package name="gimp" version="1.2.3">
  +	<packageinfo>
  +		<description>
  +		<para>The gimp package contains the GNU Image Manipulation Program.
  +			This is useful for :</para>
  +		<list>
  +			<item>photo retouching,</item>
  +			<item>image composition,</item>
  +			<item>image authoring.</item>
  +		</list>
  +		</description>
  +
  +		<requires><name>gtk+</name></requires>
  +
  +		<utilizes><name>libtiff</name></utilizes>
  +		<utilizes><name>libpng</name></utilizes>
  +		<utilizes><name>libjpeg</name></utilizes>
  +		<utilizes><name>aalib</name></utilizes>
  +		<utilizes><name>mpeg_lib</name></utilizes>
  +		<utilizes><name>python</name></utilizes>
   
  -        </required>
  +	</required>
   
   	....
   
  -    </package>
  -
  -</programlisting>
  +</package></screen></userinput>
   
   </sect2>
   
  
  
  



More information about the alfs-log mailing list