cvs commit: ALFS/docs/syntax_doc/preface changelog.xml

jwrober at linuxfromscratch.org jwrober at linuxfromscratch.org
Wed Nov 5 21:10:59 PST 2003


jwrober     03/11/05 22:10:59

  Modified:    docs/syntax_doc/alfs_dtd elem_alfs.xml elem_base.xml
                        elem_configure.xml elem_content.xml elem_copy.xml
               docs/syntax_doc/preface changelog.xml
  Log:
  updated elem_copy
  
  Revision  Changes    Path
  1.15      +1 -0      ALFS/docs/syntax_doc/alfs_dtd/elem_alfs.xml
  
  Index: elem_alfs.xml
  ===================================================================
  RCS file: /home/cvsroot/ALFS/docs/syntax_doc/alfs_dtd/elem_alfs.xml,v
  retrieving revision 1.14
  retrieving revision 1.15
  diff -u -r1.14 -r1.15
  --- elem_alfs.xml	6 Nov 2003 03:15:46 -0000	1.14
  +++ elem_alfs.xml	6 Nov 2003 05:10:59 -0000	1.15
  @@ -16,6 +16,7 @@
   </synopsis>
   
   <para>See also :  
  +
   <xref linkend="elem_configure"/>  |  
   <xref linkend="elem_copy"/>  |  
   <xref linkend="elem_download"/>  |  
  
  
  
  1.11      +5 -3      ALFS/docs/syntax_doc/alfs_dtd/elem_base.xml
  
  Index: elem_base.xml
  ===================================================================
  RCS file: /home/cvsroot/ALFS/docs/syntax_doc/alfs_dtd/elem_base.xml,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -r1.10 -r1.11
  --- elem_base.xml	6 Nov 2003 03:15:46 -0000	1.10
  +++ elem_base.xml	6 Nov 2003 05:10:59 -0000	1.11
  @@ -18,9 +18,11 @@
   <sect2>
   <title>Description</title>
   
  -<para>The element <filename>base</filename> is used to specify the base directory
  -which will be used by all the commands in the stage, unless another
  -base is specified at the level of the command as an attribute. See also :  
  +<para>The element <filename>base</filename> is used to specify the base
  +directory which will be used by all the commands in the stage (inherited),
  +unless another base is specified at the level of the command as an attribute.
  +See also :  
  +
   <xref linkend="elem_alfs"/>  |  
   <xref linkend="elem_configure"/>  |  
   <xref linkend="elem_copy"/>  |  
  
  
  
  1.9       +2 -0      ALFS/docs/syntax_doc/alfs_dtd/elem_configure.xml
  
  Index: elem_configure.xml
  ===================================================================
  RCS file: /home/cvsroot/ALFS/docs/syntax_doc/alfs_dtd/elem_configure.xml,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- elem_configure.xml	6 Nov 2003 03:15:46 -0000	1.8
  +++ elem_configure.xml	6 Nov 2003 05:10:59 -0000	1.9
  @@ -13,11 +13,13 @@
   </synopsis>
   
   <para>This element is an element of :  
  +
   <xref linkend="elem_alfs"/>  |  
   <xref linkend="elem_stage"/>
   </para>
   
   <para>See also :  
  +
   <xref linkend="elem_param"/>  |  
   <xref linkend="elem_prefix"/>
   </para>
  
  
  
  1.6       +19 -23    ALFS/docs/syntax_doc/alfs_dtd/elem_content.xml
  
  Index: elem_content.xml
  ===================================================================
  RCS file: /home/cvsroot/ALFS/docs/syntax_doc/alfs_dtd/elem_content.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- elem_content.xml	4 Nov 2003 03:07:50 -0000	1.5
  +++ elem_content.xml	6 Nov 2003 05:10:59 -0000	1.6
  @@ -1,16 +1,16 @@
  -<sect1 id="elem_content" xreflabel="Element: <content>">
  +<sect1 id="elem_content" xreflabel="Element : <content>">
   <?dbhtml filename="elem_content.html" dir="alfs_dtd"?>
  -<title>Element: <content></title>
  +<title>Element : <content></title>
   
   <sect2>
   <title>Syntax</title>
   
   <synopsis>
  -<!ELEMENT content        (#PCDATA)>
  +<!ELEMENT content     (#PCDATA)>
   </synopsis>
   
   <para>This element occurs in the element
  -<link linkend="elem_textdump">textdump</link>.
  +<xref linkend="elem_textdump"/>.
   </para>
   
   </sect2>
  @@ -18,22 +18,23 @@
   <sect2>
   <title>Description</title>
   
  -<para>The element <token>content</token> is used to specify the content of the
  -file being created when processing a <token>textdump</token> operation.</para>
  -
  -<note><para>Of course, it is possible to use XML entity references in the
  -content of this element.</para></note>
  +<para>The element <filename>content</filename> is used to specify the content
  +of the file being created when processing a <filename>textdump</filename>
  +operation.</para>
  +
  +<note><para>Of course, it is possible to use <acronym>XML</acronym> entity
  +references in the <userinput>#PCDATA</userinput> or string of this
  +element.</para></note>
   
   </sect2>
   
   <sect2>
   <title>Examples</title>
   
  -<programlisting>
  -<textdump base="/etc">
  -        <file>group</file>
  +<screen><userinput><textdump base="/etc">
  +        <file>group</file>
   
  -        <content>
  +        <content>
                   =root:x:0:
                   =bin:x:1:
                   =sys:x:2:
  @@ -46,17 +47,14 @@
                   =lp:x:9:
                   =dialout:x:10:
                   =audio:x:11:
  -        </content>
  -</textdump>
  -</programlisting>
  +        </content>
  +</textdump></userinput></screen>
   
   <para>The equivalent bash script is :</para>
   
  -<programlisting>
  -echo Generating file group
  +<screen><userinput>echo Generating file group
   cd /etc
  -
  -cat > group << 'EOF'
  +<command>cat > group << 'EOF'</command>
   root:x:0:
   bin:x:1:
   sys:x:2:
  @@ -69,9 +67,7 @@
   lp:x:9:
   dialout:x:10:
   audio:x:11:
  -EOF
  -
  -</programlisting>
  +<command>EOF</command></userinput></screen>
   
   </sect2>
   
  
  
  
  1.6       +41 -38    ALFS/docs/syntax_doc/alfs_dtd/elem_copy.xml
  
  Index: elem_copy.xml
  ===================================================================
  RCS file: /home/cvsroot/ALFS/docs/syntax_doc/alfs_dtd/elem_copy.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- elem_copy.xml	4 Nov 2003 03:07:50 -0000	1.5
  +++ elem_copy.xml	6 Nov 2003 05:10:59 -0000	1.6
  @@ -1,27 +1,27 @@
  -<sect1 id="elem_copy" xreflabel="Element: <copy>">
  +<sect1 id="elem_copy" xreflabel="Element : <copy>">
   <?dbhtml filename="elem_copy.html" dir="alfs_dtd"?>
  -<title>Element: <copy></title>
  +<title>Element : <copy></title>
   
   <sect2>
   <title>Syntax</title>
   
   <synopsis>
  -<!ELEMENT copy           (option*, source+, destination)>
  +<!ELEMENT copy     (option*, source+, destination)>
   <!ATTLIST copy
  -          base           CDATA #IMPLIED>
  +             base      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 is an element of :  
  +
  +<xref linkend="elem_alfs"/>  |  
  +<xref linkend="elem_stage"/>
   </para>
   
  -<para>See also :
  -<link linkend="elem_option">option</link>,
  -<link linkend="elem_source">source</link>,
  -<link linkend="elem_destination">destination</link>.
  +<para>See also :  
  +
  +<xref linkend="elem_option"/>  |  
  +<xref linkend="elem_source"/>  |  
  +<xref linkend="elem_destination"/>
   </para>
   
   </sect2>
  @@ -29,47 +29,50 @@
   <sect2>
   <title>Description</title>
   
  -<para>The element <token>copy</token> is used to copy one or several source
  -files and/or directories  into a destination file or directory</para>
  +<para>The element <filename>copy</filename> is one of the many main operation
  +elements. The element <filename>copy</filename> is used to copy one or several
  +source files and/or directories into a destination file or directory</para>
  +
  +<para>The element <filename>option</filename> is optional and can be used one
  +or many times to ensure the correct use of the <filename>cp</filename>
  +command.  The following is the currently supported list of options for the
  +<filename>cp</filename> command :
   
  -<para>The supported options are options of the cp command:
   <itemizedlist>
  -<listitem><para>archive</para></listitem>
  -<listitem><para>force</para></listitem>
  -<listitem><para>no-dereference</para></listitem>
  -<listitem><para>preserve</para></listitem>
  -<listitem><para>recursive</para></listitem>
  +<listitem><para>archive (-a, --archive)</para></listitem>
  +<listitem><para>force (-f, --force)</para></listitem>
  +<listitem><para>no-dereference (-d, --no-dereference)</para></listitem>
  +<listitem><para>preserve (-p, --preserve)</para></listitem>
  +<listitem><para>recursive (-R, -r, --recursive)</para></listitem>
   </itemizedlist>.
   </para>
   
  -<para>When processing this element, one copy each source
  -to the destination, using the specified options.</para>
  +<para>The element <filename>source</filename> is required and can be used many
  +times to provide multiple source locations for a file.</para>
   
  -<para>When the attribute <token>base</token> is specified,
  -it should contain the name of the current directory
  -from which the copy operation is performed.
  -</para>
  +<para>The element <filename>destination</filename> is required and can only be
  +used once.  A <filename>copy</filename> can only have one destination.</para>
  +
  +<para>The attribute <filename>base</filename> allows you to specify the
  +directory in which the command is executed. See
  +<xref linkend="elem_base"/>.</para>
   
   </sect2>
   
   <sect2>
   <title>Examples</title>
   
  -<programlisting>
  -<copy base="/usr/src/mypackage">
  -   <option>force</option>
  -   <source>config.txt</source>
  -   <destination>/opt/mypackage/config.txt</destination>
  -</copy>
  -</programlisting>
  +<screen><userinput><copy base="/usr/src/mypackage">
  +	<option>force</option>
  +	<source>config.txt</source>
  +	<destination>/opt/mypackage/config.txt</destination>
  +</copy></userinput></screen>
   
   <para>The equivalent bash script is :</para>
   
  -<programlisting>
  -echo Copying ' config.txt into /opt/mypackage/config.txt'
  +<screen><userinput>echo Copying 'config.txt into /opt/mypackage/config.txt'
   cd /usr/src/mypackage
  -cp -f  config.txt /opt/mypackage/config.txt
  -</programlisting>
  +<command>cp -f  config.txt /opt/mypackage/config.txt</command></userinput></screen>
   
   </sect2>
   
  
  
  
  1.15      +3 -2      ALFS/docs/syntax_doc/preface/changelog.xml
  
  Index: changelog.xml
  ===================================================================
  RCS file: /home/cvsroot/ALFS/docs/syntax_doc/preface/changelog.xml,v
  retrieving revision 1.14
  retrieving revision 1.15
  diff -u -r1.14 -r1.15
  --- changelog.xml	6 Nov 2003 02:40:03 -0000	1.14
  +++ changelog.xml	6 Nov 2003 05:10:59 -0000	1.15
  @@ -9,8 +9,9 @@
   <listitem><para>November 5th, 2003 [jwrober]: Added
   elem_prefix.</para></listitem>
   
  -<listitem><para>November 5th, 2003 [jwrober]: Updated elem_configure to match
  -the DTD and standardized to the rest of the doc.</para></listitem>
  +<listitem><para>November 5th, 2003 [jwrober]: Updated elem_configure,
  +elem_copy to match the DTD and standardized to the rest of the
  +doc.</para></listitem>
   
   <listitem><para>November 4th, 2003 [jwrober]: Updated elem_alfs, elem_archive,
   elem_base to match the DTD; also began the element standardization with the
  
  
  



More information about the alfs-log mailing list