cvs commit: ALFS/docs/syntax_doc/alfs_dtd elem_digest.xml elem_download.xml

jwrober at linuxfromscratch.org jwrober at linuxfromscratch.org
Sun Feb 22 19:09:38 PST 2004


jwrober     04/02/22 20:09:38

  Modified:    docs/syntax_doc/alfs_dtd elem_digest.xml elem_download.xml
  Log:
  finished first pass across all elements
  
  Revision  Changes    Path
  1.6       +21 -18    ALFS/docs/syntax_doc/alfs_dtd/elem_digest.xml
  
  Index: elem_digest.xml
  ===================================================================
  RCS file: /home/cvsroot/ALFS/docs/syntax_doc/alfs_dtd/elem_digest.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- elem_digest.xml	4 Nov 2003 03:07:50 -0000	1.5
  +++ elem_digest.xml	23 Feb 2004 03:09:37 -0000	1.6
  @@ -6,22 +6,27 @@
   <title>Syntax</title>
   
   <synopsis>
  -<!ELEMENT digest    (#PCDATA)>
  -<ATTLIST digest
  -         type      CDATA  "md5">
  +<!ELEMENT digest         (#PCDATA)>
  +<!ATTLIST digest
  +          type           CDATA "md5">
   </synopsis>
   
  -<para>This element occurs in the element
  -<link linkend="elem_download">download</link> and
  -<link linkend="elem_unpack">unpack</link>.
  -.</para>
  +<para>This element occurs in the elements ;  
  +<xref linkend="elem_download"/>  |  
  +<xref linkend="elem_unpack"/>
  +</para>
  +
   </sect2>
   
   <sect2>
   <title>Description</title>
   
  -<para>The element <token>unpack</token> is used to specify the
  -digest of the archive file to be unpacked, or of the file to be downloaded.
  +<para>The element <filename>unpack</filename> is used to specify the digest
  +of the archive file to be unpacked, or of the file to be downloaded.
  +</para>
  +
  +
  +<para>The attribute <filename>type</filename> is preset as an MD5 hash.
   </para>
   
   </sect2>
  @@ -29,16 +34,14 @@
   <sect2>
   <title>Examples</title>
   
  -<programlisting>
  -<download>
  -    <file>kbd-1.08.tar.gz</file>
  -    <url>ftp://ftp.win.tue.nl/pub/linux-local/utils/kbd/</url>
  -    <destination>/tmp/</destination>
  -    <digest>924e6a05e52715dc0f96385b35f2f680</digest>
  -</download>
  -</programlisting>
  +<userinput><screen><download>
  +	<file>kbd-1.08.tar.gz</file>
  +	<url>ftp://ftp.win.tue.nl/pub/linux-local/utils/kbd/</url>
  +	<destination>/tmp/</destination>
  +	<digest>924e6a05e52715dc0f96385b35f2f680</digest>
  +</download></screen></userinput>
   
  -<para>YAALFS does not process this element yet.</para>
  +<para>There is no equivalent Bash script example for this element.</para>
   
   </sect2>
   
  
  
  
  1.6       +40 -36    ALFS/docs/syntax_doc/alfs_dtd/elem_download.xml
  
  Index: elem_download.xml
  ===================================================================
  RCS file: /home/cvsroot/ALFS/docs/syntax_doc/alfs_dtd/elem_download.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- elem_download.xml	4 Nov 2003 03:07:50 -0000	1.5
  +++ elem_download.xml	23 Feb 2004 03:09:37 -0000	1.6
  @@ -6,21 +6,19 @@
   <title>Syntax</title>
   
   <synopsis>
  -<!ELEMENT download    (file,url*,destination,digest?)>
  +<!ELEMENT download       (file, url*, destination, digest?)>
   </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_file">file</link>,
  -<link linkend="elem_destination">destination</link>,
  -<link linkend="elem_digest">digest</link>,
  -<link linkend="elem_url">url</link>,
  +<para>See also :  
  +<xref linkend="elem_file"/>  |  
  +<xref linkend="elem_url"/>  |  
  +<xref linkend="elem_destination"/>  |  
  +<xref linkend="elem_digest"/>
   </para>
   
   </sect2>
  @@ -28,44 +26,50 @@
   <sect2>
   <title>Description</title>
   
  -<para>The element <token>download</token> is used to specify
  -one or several urls from which a file can be downloaded,
  -and optionally a digest to check that the file being downloaded
  -if the right one.
  +<para>The element <filename>download</filename> is one of the many main
  +operation elements. It is used to specify one or several urls from which a
  +file can be downloaded, and optionally a digest to check that the file
  +being downloaded if the right one.
   </para>
   
  -<para>The sub-element file contains the name of the file to be downloaded.</para>
  +<para>The sub-element <filename>file</filename> contains the name of the
  +file to be downloaded.
  +</para>
   
  -<para>The sub-element url contains the url of the directory from
  -which the download is performed. It should be terminated by a slash ("/").
  -More precisely, the actual url used for the download is the catenation of the content
  -of the url element with the content of the file element.</para>
  +<para>The sub-element <filename>url</filename> contains the url of the
  +directory from which the download is performed. It should be terminated by
  +a slash [ / ]. More precisely, the actual url used for the
  +download is the catenation of the content of the url element with the
  +content of the file element. This element is optional, but if used can be
  +used more than once.
  +</para>
   
  -<para>The sub-element destination contains the path of the directory
  -into which the download should be performed.</para>
  +<para>The sub-element <filename>destination</filename> contains the path of
  +the directory into which the download should be performed.
  +</para>
   
  -<para>The sub-element digest contains the value with which the
  -digest computed from the dowloaded file (e.g. computed using
  -the md5 algorithm) will be compared.</para>
  +<para>The sub-element <filename>digest</filename> contains the value with
  +which the digest computed from the dowloaded file (e.g. computed using the
  +md5 algorithm) will be compared. This sub-element is optional.
  +</para>
   
  -<para>If the file is already present in the destination directory,
  -no download is performed but the digest is checked if present.</para>
  +<para>If the file is already present in the destination directory, no
  +download is performed but the digest is checked if present.
  +</para>
   
   </sect2>
   
   <sect2>
   <title>Examples</title>
   
  -<programlisting>
  -<download>
  -    <file>kbd-1.08.tar.gz</file>
  -    <url>ftp://ftp.win.tue.nl/pub/linux-local/utils/kbd/</url>
  -    <destination>/tmp/</destination>
  -    <digest>924e6a05e52715dc0f96385b35f2f680</digest>
  -</download>
  -</programlisting>
  +<userinput><screen><download>
  +	<file>kbd-1.08.tar.gz</file>
  +	<url>ftp://ftp.win.tue.nl/pub/linux-local/utils/kbd/</url>
  +	<destination>/tmp/</destination>
  +	<digest>924e6a05e52715dc0f96385b35f2f680</digest>
  +</download></screen></userinput>
   
  -<para>YAALFS does not process this element yet.</para>
  +<para>There is no equivalent Bash script example for this element.</para>
   
   </sect2>
   
  
  
  



More information about the alfs-log mailing list