libs/setup.1.txt

Wed, 05 Aug 2009 23:34:02 +0800

author
Tim Post <echo@echoreply.us>
date
Wed, 05 Aug 2009 23:34:02 +0800
branch
tinkertim
changeset 20
f5a98db22166
permissions
-rw-r--r--

Add asciidoc man1 template for setup program

     1 Unistall(1)
     2 ===========
     3 Tim Post <tinkertim@gmail.com>
     5 NAME
     6 ----
     7 Unistall - A smart system for installing application suites
     9 SYNOPSIS
    10 --------
    11 'unistall' <options>
    13 DESCRIPTION
    14 -----------
    15 Unistall is a smart installation utility designed to make installing large
    16 suites of applications as easy as possible across many dis-similar GNU/Linux
    17  distributions. Application suites that must install packages from the
    18 distribution packaging mechanism, build programs from source and install to
    19 locations that differ from distribution to distribution are good candidates
    20 for unistall. Unistall was written to allow GNUPanel, a free web hosting
    21 automation system to install and work on many popular distributions without
    22 the need to maintain special packages for each kind. Much like the common
    23 autoconf ./configure program, unistall gathers your preferences and adjusts
    24 to your system.
    26 OPTIONS
    27 -------
    28 The following options are nearly identical to the standard ./configure options,
    29 areas that differ are noted.
    30 -p, --prefix=[dir]::
    31 	Specify the installation prefix, identical to ./configure
    32 -e, --exec-prefix=[dir]::
    33 	Similar to the ./configure directive, but not relative to PREFIX.
    34 -b, --bindir=[dir]::
    35 	Specify where programs used by underprivileged users should be installed.
    36 -s, --sbindir=[dir]::
    37 	Specify where root/admin programs should go.
    38 -l, --libdir=[dir]::
    39 	Specify where libraries should be installed
    40 -S, --sysconfdir=[dir]::
    41 	Specify an alternate to /etc for text configuration files
    42 -d, --datarootdir=[dir]::
    43 	Specify the data root, (PREFIX/share)
    44 -m, --mandir=[dir]::
    45 	Specify where documentation should be installed
    47 INSTALLER BEHAVIOR
    48 ------------------
    49 Unistall aims to give the user complete control over the installation process,
    50 should the user desire such control. All parts of the process can be skipped
    51 and one can pass switches to approve nearly every action. This helps to ensure
    52 that existing programs aren't obliterated during the installation process.
    53 -a, --auto-packages=[y|n]::
    54 	If set to no, you will be prompted prior to each OS package being installed
    55 -c, --show-defaults::
    56 	Show the default settings to review what will happen prior to installing
    57 -D, --skip-deps::
    58 	Skip dependency checks (probably a bad idea)
    59 -f, --force::
    60 	Keep going even if errors occur
    61 -P, --skip-packages::
    62 	Do not invoke the OS package utility, do not install any OS packages.
    63 -t, --skip-tasks::
    64 	Do not process scripts to install anything, merely install OS packages.
    65 -u, --use-dialog=[y|n]::
    66 	Toggle using dialog (ncurses) input boxes to ask for input when needed.
    68 MISCELLANEOUS OPTIONS
    69 ---------------------
    70 -C, --clean::
    71 	Clean any files generated by running the setup program
    72 -h, --help::
    73 	Show a brief help summary
    74 -M, --manual::
    75 	Show this detailed manual
    76 -v, --version::
    77 	Print version information and exit
    79 OPERATION
    80 ---------
    81 Unistall first does some basic sanity checks, to ensure that the shell
    82 interpreting it is capible of executing the code. Upon success, Unistall
    83 will begin checking for the presence of basic core utilities and recording
    84 their location in a file named paths.in.
    86 Unistall will then determine your type of GNU/Linux distribution and
    87 determine your system packaging mechanism (yum, poldek, apt-get, etc).
    88 Paths to these programs are then recorded in paths.in.
    90 If your system meets the minimum requirements, unistall will query your
    91 system packaging utility to determine what you have installed so that it
    92 knows what must be installed via packages provided by your distribution.
    94 If a top level source tree is defined, unistall will seek out confiugre
    95 programs within the tree, these will be invoked with the prefix and other
    96 preferences passed to the setup utility.
    98 Finally, unistall will parse a special macro driven list of tasks that
    99 must be completed (again, specific to your distribution) in order to install
   100 the application suite. Once all of this has been completed, unistall will
   101 create a file named install.sh that contains portable shell code to effectively
   102 install the application suite.
   104 The resulting install.sh 
   106 PORTABILITY
   107 -----------
   108 Unistall is written in portable shell code, so that it can work on as many
   109 variants of the GNU/Linux operating system as possible. It has been tested
   110 under Ash, Busybox, Bash, Dash, Pdksh and Zsh. Unistall should work well
   111 under any Bourne compatible shell released after 1996, for 10+ years
   112 backwards compatibility.
   114 SEE ALSO
   115 --------
   117 AUTHOR
   118 ------
   119 Written by Tim Post and Alex Karlov,
   120 Maintained by Tim Post <tinkertim@gmail.com>
   122 COPYING
   123 -------
   124 Copyright \(C) 2004-2007 Tim Post - All Rights Reserved
   125 You may copy, distribute and modify SRCE under the terms of the GNU GPL v3
   126 license, or (at your option) any later version.

mercurial