cvs commit: ALFS/nALFS README

kpfleming at linuxfromscratch.org kpfleming at linuxfromscratch.org
Sun Dec 21 09:15:55 PST 2003


kpfleming    03/12/21 10:15:55

  Modified:    nALFS    README
  Log:
  major updates, fix spelling/grammar errors, add warnings about unimplemented DTD elements
  
  Revision  Changes    Path
  1.10      +65 -46    ALFS/nALFS/README
  
  Index: README
  ===================================================================
  RCS file: /home/cvsroot/ALFS/nALFS/README,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- README	12 Nov 2003 04:23:46 -0000	1.9
  +++ README	21 Dec 2003 17:15:55 -0000	1.10
  @@ -1,4 +1,4 @@
  -nALFS, version 1.1.8
  +nALFS, version CVS
   ====================
   
   
  @@ -33,16 +33,16 @@
   1. LFS, ALFS
   ============
   
  -LFS stands for Linux From Scratch and it's a project, led by Gerard
  +LFS stands for Linux From Scratch and its a project, led by Gerard
   Beekmans <gerard at linuxfromscratch.org>, which helps you build your own
   Linux system.
   
   What this means is that you will be using nothing but the source code
  -of various packages needed for fully functional Linux system. You will
  -compile them, one be one, on your own machine, and therefore, they
  -will be maximally optimized for it. Also, you will be able to tweak
  -every single corner of your system, by editing bunch of configuration
  -files, creating your own boot scripts etc.
  +of various packages needed for a fully functional Linux system. You
  +will compile them, one by one, on your own machine, and therefore they
  +will be maximally configured for it. Also you will be able to tweak
  +every single corner of your system, by editing the configuration
  +files, creating your own boot scripts and more.
   
   All this might sound a bit complicated, requiring too much work. But
   even if it is, it's well worth it.
  @@ -54,9 +54,9 @@
   ALFS stands for Automated Linux From Scratch, and its aim is to
   provide a much simpler method for building a Linux system.
   
  -ALFS uses the profiles, simple XML files, which describe what actions
  -are to be taken and what commands executed. Feeding the program (like
  -nALFS) with those profiles, will make the program act upon them.
  +ALFS uses the profiles, simple XML files, which describe the actions
  +to be taken and what commands to execute. Feeding the program (like
  +nALFS) the profiles, will make the program act upon them.
   
   For example, if you want to create a directory, all you have to do is
   to put:
  @@ -96,17 +96,18 @@
       ./configure
       make
       make install
  -    nALFS profiles/LFS/latest.xml
  +    nALFS profile/LFS-*/LFS-*.xml
   
  -When you enter the program, type '?' for a list of all available
  -commands.
  +This will start nALFS using the latest stable LFS profile, which is
  +included in the nALFS distribution. When you enter the program, type
  +'?' for a list of all available commands.
   
   
   3. Requirements
   ===============
   
  -For actual parsing of XML profiles, nALFS uses libxml2 (a.k.a. gnome-xml)
  -library. You can find it on its homepage, http://xmlsoft.org/.
  +For actual parsing of XML profiles, nALFS uses the libxml2 (aka
  +gnome-xml) library. You can find it on the web at http://xmlsoft.org/.
   
   If you use <download> and/or <unpack> elements in your profiles, and wish
   to have the source file contents verified by computing digests, you can
  @@ -114,14 +115,27 @@
   nALFS. If you wish to use digests other than MD5 (i.e. SHA-1), nALFS can
   be built using the OpenSSL library from http://www.openssl.org/.
   
  -If you use <download> elements in your profiles and wish to get better
  -download performance (and more reliability) than using "wget" for the
  -download processes, nALFS can be built using the curl libraries that are
  -included in the curl distribution from http://curl.haxx.se/.
  +If you use <download> and/or <unpack> elements in your profiles and
  +wish to get better download performance (and more reliability) than
  +using "wget" for the download processes, nALFS can be built using the
  +curl libraries that are included in the curl distribution from
  +http://curl.haxx.se/.
  +
  +A copy of the DTD used to validate ALFS profiles is included in the
  +nALFS distribution, at doc/ALFS.dtd. This file can be used with the
  +xmllint tool from the libxml2 distribution to check whether your
  +profile(s) conform to the ALFS profile specification. Using this tool
  +is a fast and easy way to check for typing/spelling errors and other
  +simple syntactical problems that nALFS would find when it loads your
  +profiles.
  +
  +Note: At this time, the ALFS DTD includes <if>, <then> and <else>
  +elements that nALFS does not currently implement. In addition, nALFS
  +does not implement the <description> element used in
  +<packageinfo>. These problems will be rectified in a future release.
   
   
  -4. Compiling and installing
  -===========================
  +4. Compiling and installing ===========================
   
   First, you have to configure the package by typing:
   
  @@ -129,10 +143,11 @@
   
   To see the list of all available options, use "./configure --help".
   
  -nALFS supports (at least) three different ALFS profile versions: 2.0, 3.0
  -and 3.1. If not otherwise specified, the build process will build handlers
  -for all these versions. If you would like to exclude building handlers for
  -profile versions that you do not use, you can include the --enable-syntax
  +nALFS supports (at least) four different ALFS profile versions: 2.0,
  +3.0, 3.1 and 3.2. If not otherwise specified, the build process will
  +build handlers for all the current versions (version 3.0 and
  +greater). If you would like to exclude building handlers for profile
  +versions that you do not use, you can include the --enable-syntax
   argument to the configure command, like so:
   
       ./configure --enable-syntax=3.0,3.1
  @@ -164,10 +179,11 @@
   experience problems due to libcurl's use of the resolver library provided
   by glibc.
   
  -By default, nALFS executable will be stored in /usr/local/bin, while
  -handlers will be copied to /usr/local/lib/nALFS directory.
  +By default, the nALFS executable will be installed into
  +/usr/local/bin, while handlers will be installed into the
  +/usr/local/lib/nALFS directory.
   
  -You can change these defaults by specifying --prefix or --libdir
  +You can change these defaults by specifying the --prefix or --libdir
   options to configure.
   
   Then, after configuring, type:
  @@ -184,13 +200,15 @@
   
   Just type:
   
  -    nALFS profiles/LFS/latest.xml
  -
  -where "profiles/LFS/latest.xml" is your favorite profile. Multiple
  -profiles separated with spaces can also be specified.
  +    nALFS profile/LFS-*/LFS-*.xml
   
  -nALFS reads ~/.nALFSrc file, in which different options can be set.
  -An example of this file is located in doc/ directory.
  +where "profiles/LFS-*/LFS-*.xml" is the current stable LFS profile
  +distributed with the nALFS package. Multiple profiles separated by
  +spaces can also be specified.
  +
  +nALFS reads the /etc/nALFSrc file, then the ~/.nALFSrc file, in which
  +different options can be set.  An example of these files is located in
  +the doc directory.
   
   When you enter the program, you can press '?' to display a list of all
   available commands. They might be described here in detail one day -
  @@ -254,8 +272,8 @@
   5.4 Options indicators
   ----------------------
   
  -All options are changeable with 'o' (quickly) and 'O' (after entering the
  -options' menu).
  +All options are changeable with 'o' (quickly) and 'O' (to enter the
  +options menu).
   
   --| r a c v s o w h f B |--
   
  @@ -287,7 +305,7 @@
   5.5 Searching the profile
   -------------------------
   
  -By pressing '/', you will be prompted to enter a search string.
  +After pressing '/', you will be prompted to enter a search string.
   Depending on your input (listed below), the search can be performed on
   various parts of the profile:
   
  @@ -298,7 +316,7 @@
      ~p <string>  - names of the packages
      ~P <string>  - names of the packages (the exact match)
   
  -The last two can be especially useful, if you're trying to locate a
  +The last two can be especially useful if you're trying to locate a
   specific package in some large profile.
   
   Searches are not case sensitive.
  @@ -308,8 +326,7 @@
   ------------------------
   
   Using a command-line option -i (or --interactive) will toggle the mode
  -in which nALFS will run. By default (defined in config.h), nALFS runs
  -in the interactive mode.
  +in which nALFS will run. By default ALFS runs in the interactive mode.
   
   However, it can also run in a non-interactive mode. By doing so, the
   program will start executing the profiles immediately, without any
  @@ -323,16 +340,18 @@
   one, to nALFS. By checking the program's return value, you could act
   accordingly.
   
  -
   If you have any problems, either when compiling, running, or using the
  -program, do email me. Any suggestions, ideas, bug reports, patches etc.
  -are also highly welcome and can be sent to the address below.
  -
  +program, do email us. Any suggestions, ideas, bug reports, patches
  +etc. are also highly welcome and can be sent to the address below.
   
   For the latest version of the program:
   
       http://www.linuxfromscratch.org/alfs/
   
  +For comments, questions or other information about the program, the
  +alfs-discuss mailing list in section 1 of this document is the best
  +method to contact the developers and others users of the program.
  +
  +Neven Has <haski at sezampro.yu>
   
  -Neven Has
  -haski at sezampro.yu
  +Kevin P. Fleming <kpfleming at linuxfromscratch.org>
  
  
  



More information about the alfs-log mailing list