1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/libs/setup.1.txt Wed Aug 05 23:34:02 2009 +0800
1.3 @@ -0,0 +1,126 @@
1.4 +Unistall(1)
1.5 +===========
1.6 +Tim Post <tinkertim@gmail.com>
1.7 +
1.8 +NAME
1.9 +----
1.10 +Unistall - A smart system for installing application suites
1.11 +
1.12 +SYNOPSIS
1.13 +--------
1.14 +'unistall' <options>
1.15 +
1.16 +DESCRIPTION
1.17 +-----------
1.18 +Unistall is a smart installation utility designed to make installing large
1.19 +suites of applications as easy as possible across many dis-similar GNU/Linux
1.20 + distributions. Application suites that must install packages from the
1.21 +distribution packaging mechanism, build programs from source and install to
1.22 +locations that differ from distribution to distribution are good candidates
1.23 +for unistall. Unistall was written to allow GNUPanel, a free web hosting
1.24 +automation system to install and work on many popular distributions without
1.25 +the need to maintain special packages for each kind. Much like the common
1.26 +autoconf ./configure program, unistall gathers your preferences and adjusts
1.27 +to your system.
1.28 +
1.29 +OPTIONS
1.30 +-------
1.31 +The following options are nearly identical to the standard ./configure options,
1.32 +areas that differ are noted.
1.33 +-p, --prefix=[dir]::
1.34 + Specify the installation prefix, identical to ./configure
1.35 +-e, --exec-prefix=[dir]::
1.36 + Similar to the ./configure directive, but not relative to PREFIX.
1.37 +-b, --bindir=[dir]::
1.38 + Specify where programs used by underprivileged users should be installed.
1.39 +-s, --sbindir=[dir]::
1.40 + Specify where root/admin programs should go.
1.41 +-l, --libdir=[dir]::
1.42 + Specify where libraries should be installed
1.43 +-S, --sysconfdir=[dir]::
1.44 + Specify an alternate to /etc for text configuration files
1.45 +-d, --datarootdir=[dir]::
1.46 + Specify the data root, (PREFIX/share)
1.47 +-m, --mandir=[dir]::
1.48 + Specify where documentation should be installed
1.49 +
1.50 +INSTALLER BEHAVIOR
1.51 +------------------
1.52 +Unistall aims to give the user complete control over the installation process,
1.53 +should the user desire such control. All parts of the process can be skipped
1.54 +and one can pass switches to approve nearly every action. This helps to ensure
1.55 +that existing programs aren't obliterated during the installation process.
1.56 +-a, --auto-packages=[y|n]::
1.57 + If set to no, you will be prompted prior to each OS package being installed
1.58 +-c, --show-defaults::
1.59 + Show the default settings to review what will happen prior to installing
1.60 +-D, --skip-deps::
1.61 + Skip dependency checks (probably a bad idea)
1.62 +-f, --force::
1.63 + Keep going even if errors occur
1.64 +-P, --skip-packages::
1.65 + Do not invoke the OS package utility, do not install any OS packages.
1.66 +-t, --skip-tasks::
1.67 + Do not process scripts to install anything, merely install OS packages.
1.68 +-u, --use-dialog=[y|n]::
1.69 + Toggle using dialog (ncurses) input boxes to ask for input when needed.
1.70 +
1.71 +MISCELLANEOUS OPTIONS
1.72 +---------------------
1.73 +-C, --clean::
1.74 + Clean any files generated by running the setup program
1.75 +-h, --help::
1.76 + Show a brief help summary
1.77 +-M, --manual::
1.78 + Show this detailed manual
1.79 +-v, --version::
1.80 + Print version information and exit
1.81 +
1.82 +OPERATION
1.83 +---------
1.84 +Unistall first does some basic sanity checks, to ensure that the shell
1.85 +interpreting it is capible of executing the code. Upon success, Unistall
1.86 +will begin checking for the presence of basic core utilities and recording
1.87 +their location in a file named paths.in.
1.88 +
1.89 +Unistall will then determine your type of GNU/Linux distribution and
1.90 +determine your system packaging mechanism (yum, poldek, apt-get, etc).
1.91 +Paths to these programs are then recorded in paths.in.
1.92 +
1.93 +If your system meets the minimum requirements, unistall will query your
1.94 +system packaging utility to determine what you have installed so that it
1.95 +knows what must be installed via packages provided by your distribution.
1.96 +
1.97 +If a top level source tree is defined, unistall will seek out confiugre
1.98 +programs within the tree, these will be invoked with the prefix and other
1.99 +preferences passed to the setup utility.
1.100 +
1.101 +Finally, unistall will parse a special macro driven list of tasks that
1.102 +must be completed (again, specific to your distribution) in order to install
1.103 +the application suite. Once all of this has been completed, unistall will
1.104 +create a file named install.sh that contains portable shell code to effectively
1.105 +install the application suite.
1.106 +
1.107 +The resulting install.sh
1.108 +
1.109 +PORTABILITY
1.110 +-----------
1.111 +Unistall is written in portable shell code, so that it can work on as many
1.112 +variants of the GNU/Linux operating system as possible. It has been tested
1.113 +under Ash, Busybox, Bash, Dash, Pdksh and Zsh. Unistall should work well
1.114 +under any Bourne compatible shell released after 1996, for 10+ years
1.115 +backwards compatibility.
1.116 +
1.117 +SEE ALSO
1.118 +--------
1.119 +
1.120 +AUTHOR
1.121 +------
1.122 +Written by Tim Post and Alex Karlov,
1.123 +Maintained by Tim Post <tinkertim@gmail.com>
1.124 +
1.125 +COPYING
1.126 +-------
1.127 +Copyright \(C) 2004-2007 Tim Post - All Rights Reserved
1.128 +You may copy, distribute and modify SRCE under the terms of the GNU GPL v3
1.129 +license, or (at your option) any later version.
1.130 \ No newline at end of file
