"Fossies" - the Fresh Open Source Software Archive

Member "afio-2.5.2/INSTALLATION" (30 Nov 2018, 4691 Bytes) of package /linux/misc/afio-2.5.2.tgz:

As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "INSTALLATION": 2.5.1_vs_2.5.2.

    1 
    2 To install afio, follow these steps:
    3 
    4 STEP 1. Compile.
    5 ----------------
    6 
    7 Unpack the afio sources, go to the top level source directory, compile
    8 the binary by typing:
    9 
   10 make
   11 
   12 
   13 Side note on compiler warnings:
   14 -------------------------------
   15 
   16 You may get some compiler warnings -- these do not always indicate a
   17 real problem.  (The GCC maintainers add new types of warning messages
   18 regularly, and afio is usually behind in updating the sources to
   19 eliminate new warnings.)
   20 
   21 If you see warning like:
   22 
   23  ignoring return value of X, declared with attribute warn_unused_result
   24 
   25 these are spurious are generated by a bug in glibc: they can be ignored.
   26 
   27 See the file PORTING for more information on compiling afio on
   28 non-Linux machines.
   29 
   30 STEP 2 (OPTIONAL). Regression tests.
   31 ------------------------------------
   32 
   33 Optionally, you can run some automatic regression tests to check if
   34 the new afio binary works OK.  If you have an older version of afio
   35 installed, the tests will also check (just to be extra paranoid) if
   36 the archive format used by the old binary is still interoperable with
   37 the new binary.  The formats should be compatible unless there is a
   38 serious bug.
   39 
   40 Sometimes the regression tests fail because they invoke certain unix
   41 shell tools, and the tools have changed their command line option
   42 syntax.
   43 
   44 See below for details on running the two automatic regression tests.
   45 
   46 STEP 3. Install the binary and manual page.
   47 -------------------------------------------
   48 
   49 Do this manually, or type
   50 
   51 make install
   52 
   53 which installs the afio binary in /usr/local/bin, and the manual page
   54 in /usr/share/man/man1 -- these are the correct locations for most
   55 Linux systems.
   56 
   57 Notes on using afio
   58 -------------------
   59 
   60 Afio has far too many options to be used directly from the command
   61 line, it is best used as an `archive engine' in a backup script.
   62 
   63 See the file SCRIPTS for more information on backup scripts that use
   64 afio.
   65 
   66 See the file PORTING for information on compiling afio on non-Linux
   67 machines.
   68 
   69 
   70 Details on the two automatic regression tests (step 2).
   71 -------------------------------------------------------
   72 
   73 Test 1: regtest: file handling and archive portability regression test
   74 ----------------------------------------------------------------------
   75 
   76 **Note: the test scripts may fail to work on non-GNU platforms that
   77   have very old versions of tools like awk, find, and diff.  See the
   78   PORTING file for more information.
   79 
   80 If you are going to use afio for system backups, this test is best run
   81 from the root account.  In that case the test will also try whether
   82 afio correctly invokes filesystem operations (like making devices and
   83 changing file ownership settings) that normal user accounts are not
   84 allowed to do.
   85 
   86 You can compile and run this test with
   87 
   88 make regtest
   89 
   90 This test prints a line with 'OK!' at the end it succeeds.
   91 
   92    --> this regression test is known to report small permission
   93        related problems on several Non-Linux platforms.  These mostly
   94        have to do (I think) with different approaches the kernels take
   95        to handling permissions, so these small problems do not
   96        necessarily indicate that the compiled afio is buggy.
   97 
   98 
   99 If you are unsure about interpreting the result of a regression test,
  100 please check if any recent information (e.g. in the comments) on the
  101 site http://freshmeat.net/projects/afio/ answers your question.  If
  102 not, or if you think you have found a new bug on your platform,
  103 whether Linux or not, feel free to mail the afio maintainer (see the
  104 README file).
  105 
  106 
  107 Test 2: regtest2gb: large file handling test
  108 --------------------------------------------
  109 
  110 This test tries out the large file handling capabilities of afio, and
  111 is only applicable to systems with large (>2GB) file support.  If you
  112 don't know if your system supports large files, you can find that out
  113 by running the test.
  114 
  115 This test requires a) sparse file support in the filesystem (which is
  116 present in most Unixes, including Linux, or b) 2.2 GB free space on
  117 the filesystem.  You can compile and run this test with
  118 
  119 make regtest2gb
  120 
  121 This test prints a line with 'OK!' at the end it succeeds.
  122 
  123     --> this regression test will of course fail on platforms
  124         that do not support >2GB files.
  125         Note that, if the test fails, this is often not due to a bug
  126         in afio, but more likely to a missing feature or configuration
  127         problem in the kernel, the filesystem, the compiler, or the
  128         libraries.
  129         As of Dec 2003, the test is known to report success on
  130 	  - Red Hat Linux 7.3
  131 	  - Debian Linux 3.0/testing (not 3.0/stable) on most platforms,
  132             including i386
  133           - At least some versions of Solaris
  134           - FreeBSD 3.5-STABLE
  135