1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/README.txt Sun Aug 26 20:45:41 2007 +0200
1.3 @@ -0,0 +1,108 @@
1.4 +Introduction
1.5 +------------
1.6 +
1.7 +The userinstall distribution consists of a number of scripts, together with a
1.8 +short configuration file, which allows non-root users to set up and use their
1.9 +own package repository and to download and install Debian packages without
1.10 +having to obtain root privileges. The software within installed packages may
1.11 +then be used, subject to certain constraints such as program environments,
1.12 +library paths, and so on.
1.13 +
1.14 +Contact, Copyright and Licence Information
1.15 +------------------------------------------
1.16 +
1.17 +The current Web page for userinstall at the time of release is:
1.18 +
1.19 +http://www.boddie.org.uk/paul/userinstall.html
1.20 +
1.21 +Copyright and licence information can be found in the docs directory - see
1.22 +docs/COPYING.txt and docs/gpl-3.0.txt for more information.
1.23 +
1.24 +Dependencies
1.25 +------------
1.26 +
1.27 +fakeroot Tested with 1.5.10ubuntu2
1.28 +fakechroot Tested with 2.5-1.1
1.29 +debootstrap Tested with 0.3.3.2ubuntu3
1.30 +
1.31 +Configuration
1.32 +-------------
1.33 +
1.34 +If the system defaults are not to be used, or if the software is not installed
1.35 +as a system package, the userinstall-defaults file supplied with the
1.36 +distribution may be edited to specify the nature and location of the
1.37 +repository. The following settings can be edited:
1.38 +
1.39 +DISTNAME This should reflect the distribution being used and need only
1.40 + be altered in special situations.
1.41 +PACKAGEROOT The location of the repository in the filesystem.
1.42 +
1.43 +If a completely new userinstall-defaults file is created, it is essential that
1.44 +the above variables be defined so that the scripts know where to create or to
1.45 +find the repository.
1.46 +
1.47 +Creating a Repository
1.48 +---------------------
1.49 +
1.50 +In order to install packages as a non-root user, first invoke the user-setup
1.51 +script; this will create and initialise a basic Debian system with a basic set
1.52 +of packages installed. For example, with userinstall installed as a system
1.53 +package:
1.54 +
1.55 +user-setup
1.56 +
1.57 +Or with local defaults:
1.58 +
1.59 +./user-setup
1.60 +
1.61 +It is possible to override the "template" for the repository by specifying a
1.62 +"mirror" location. This is useful if you have the CD or DVD image for the
1.63 +distribution locally mounted. For example:
1.64 +
1.65 +user-setup file:///cdrom
1.66 +user-setup file:///home/me/downloads/kubuntu-7.04-alternate-i386.iso
1.67 +
1.68 +Adding Package Sources to the Repository
1.69 +----------------------------------------
1.70 +
1.71 +To get access to sources of packages beyond those provided by the basic
1.72 +distribution, edit the etc/apt/sources.list file inside the repository. The
1.73 +user-path script can help you find the exact location of the file:
1.74 +
1.75 +user-path etc/apt/sources.list
1.76 +
1.77 +Or with local defaults:
1.78 +
1.79 +./user-path etc/apt/sources.list
1.80 +
1.81 +And you can edit the file directly with a text editor (such as vi) as follows:
1.82 +
1.83 +vi `user-path etc/apt/sources.list`
1.84 +
1.85 +Or with local defaults:
1.86 +
1.87 +vi `./user-path etc/apt/sources.list`
1.88 +
1.89 +Installing Packages
1.90 +-------------------
1.91 +
1.92 +To install packages from other repositories, invoke the user-apt-get script
1.93 +with the options expected by the regular apt-get program. For example:
1.94 +
1.95 +user-apt-get --help
1.96 +user-apt-get update
1.97 +user-apt-get install python-cmdsyntax
1.98 +
1.99 +Provided that the specified packages are known and their dependencies can be
1.100 +met, they will be installed into the repository.
1.101 +
1.102 +Installing Single Packages
1.103 +--------------------------
1.104 +
1.105 +To install individual package files, invoke the user-dpkg-i script with the
1.106 +name of the package file. For example:
1.107 +
1.108 +user-dpkg-i /home/me/downloads/python-cmdsyntax_0.91-0ubuntu2_all.deb
1.109 +
1.110 +This script will copy the file into the repository environment and run dpkg
1.111 +with the -i (install) option.