Fixed up the docs a bit

Author: jgg
Date: 1998-11-23 01:15:56 GMT
Fixed up the docs a bit

diff --git a/doc/apt-get.8 b/doc/apt-get.8
index c53dc70d7d32f5a2d93abd6439c7b0a5fdb46287..48e453dbaf51db4fcd93d2c6b362dea501e1372f 100644 (file)
--- a/doc/apt-get.8
+++ b/doc/apt-get.8
@@ -1,4 +1,4 @@
-.\" $Id: apt-get.8,v 1.1 1998/07/02 02:58:12 jgg Exp $\r
+.\" $Id: apt-get.8,v 1.2 1998/11/23 01:15:56 jgg Exp $\r

 .\" This manpage is copyright (C) 1998 Branden Robinson <branden@debian.org>.\r
 .\" \r
 .\" This is free software; you may redistribute it and/or modify\r
 .\" This manpage is copyright (C) 1998 Branden Robinson <branden@debian.org>.\r
 .\" \r
 .\" This is free software; you may redistribute it and/or modify\r


@@ -230,7 +230,6 @@ storage area for state information for each package resource specified in
 .I /var/state/apt/lists/partial/\r
 storage area for state information in transit\r
 .SH SEE ALSO\r
 .I /var/state/apt/lists/partial/\r
 storage area for state information in transit\r
 .SH SEE ALSO\r

-.BR apt (8),\r

 .BR apt-cache (8),\r
 .BR dpkg (8),\r
 .BR dselect (8),\r
 .BR apt-cache (8),\r
 .BR dpkg (8),\r
 .BR dselect (8),\r

diff --git a/doc/apt.8 b/doc/apt.8
index 08aa2c4fd24655e0a594ac10f0e3970374fa3314..eafd4d7ec7e0118473bb125168c073de6e3491a1 100644 (file)
--- a/doc/apt.8
+++ b/doc/apt.8
@@ -31,7 +31,6 @@ None.
 .SH SEE ALSO
 .BR apt-cache (8),
 .BR apt-get (8),
 .SH SEE ALSO
 .BR apt-cache (8),
 .BR apt-get (8),

-.BR ftp.conf (5),

 .BR sources.list (5)
 .SH DIAGNOSTICS
 apt returns zero on normal operation, decimal 100 on error.
 .BR sources.list (5)
 .SH DIAGNOSTICS
 apt returns zero on normal operation, decimal 100 on error.

diff --git a/doc/ftp.conf.5 b/doc/ftp.conf.5
deleted file mode 100644 (file)
index 30c7c03..0000000
--- a/doc/ftp.conf.5
+++ /dev/null
@@ -1,93 +0,0 @@
-.\" This manpage is copyright (C) 1998 Branden Robinson <branden@debian.org>\r
-.\" and Manoj Srivastava <srivasta@datasync.com>.\r
-.\" \r
-.\" This is free software; you may redistribute it and/or modify\r
-.\" it under the terms of the GNU General Public License as\r
-.\" published by the Free Software Foundation; either version 2,\r
-.\" or (at your option) any later version.\r
-.\"\r
-.\" This is distributed in the hope that it will be useful, but\r
-.\" WITHOUT ANY WARRANTY; without even the implied warranty of\r
-.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
-.\" GNU General Public License for more details.\r
-.\"\r
-.\" You should have received a copy of the GNU General Public\r
-.\" License along with APT; if not, write to the Free Software\r
-.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA \r
-.\" 02111-1307 USA\r
-.TH ftp.conf 5 "16 June 1998" "Debian GNU/Linux"\r
-.SH NAME\r
-ftp.conf \- configuration file for APT FTP method\r
-.SH DESCRIPTION\r
-The ftp.conf file determines the behavior of the FTP method for the APT\r
-packaging tool.  The syntax of the file is\r
-.IR variable = value .\r
-Quotes are not required around\r
-.IR value s.\r
-Comments start with a '#' and end at the next newline. Blank lines are  \r
-ignored. The following\r
-.I variables\r
-are understood:                        \r
-.IP Firewall\r
-is the hostname of a machine which acts as an FTP firewall. This can be \r
-overridden by an environment variable                                   \r
-.IR FTP_FIREWALL .\r
-If specified, and the given hostname cannot be directly contacted, a connection\r
-is made to the firewall machine and the string\r
-.B @hostname\r
-is appended to the login identifier. This type of setup is also known as an\r
-FTP proxy.\r
-.IP ProxyLogName\r
-is a parameter used by some firewall FTP proxies. It is used to authorize\r
-the user specified by\r
-.I ProxyLogName\r
-to send data beyond the\r
-.I Firewall\r
-machine.\r
-.IP ProxyPassword\r
-is the password used to authenticate\r
-.I ProxyLogName\r
-on the\r
-.I Firewall\r
-machine.\r
-.IP TimeOut\r
-sets a timeout value in seconds (the default is sixty seconds).\r
-.IP Passive\r
-is either\r
-.B true\r
-or\r
-.BR false .\r
-If true, then all data transfers will be done using passive mode. This is\r
-required for some dumb FTP servers and firewall configurations. It can\r
-also be overridden by the environment variable\r
-.IR FTP_PASSIVE .\r
-.IP Verbose\r
-is either\r
-.B true\r
-or\r
-.B false,\r
-and makes the FTP method output more data than it normally does.\r
-.IP Debug\r
-is either\r
-.B true\r
-or\r
-.B false,\r
-and makes the FTP method output debugging information. This variable is \r
-not currently implemented.                                              \r
-.IP MaxReTry\r
-sets the number of times a connection is re-tried before giving up (the\r
-default is twice).\r
-.SH SEE ALSO\r
-.BR apt (8),\r
-.BR apt-get (8)\r
-.SH BUGS\r
-See <http://www.debian.org/Bugs/db/pa/lapt.html>.  If you wish to report a\r
-bug in\r
-.BR apt-get ,\r
-please see\r
-.I /usr/doc/debian/bug-reporting.txt\r
-or the\r
-.BR bug (1)\r
-command.\r
-.SH AUTHOR\r
-APT was written by the APT team <apt@packages.debian.org>.\r

diff --git a/doc/guide.sgml b/doc/guide.sgml
index bbc01b78b0f7a3556a3f7dfd5e215cab772e10ee..67efbc93f08696cf0e79eb50ce82df6d12613bfc 100644 (file)
--- a/doc/guide.sgml
+++ b/doc/guide.sgml
@@ -4,7 +4,7 @@
 <title>APT User's Guide</title>
 
 <author>Jason Gunthorpe <email>jgg@debian.org</email></author>
 <title>APT User's Guide</title>
 
 <author>Jason Gunthorpe <email>jgg@debian.org</email></author>

-<version>$Id: guide.sgml,v 1.1 1998/07/02 02:58:12 jgg Exp $</version>
+<version>$Id: guide.sgml,v 1.2 1998/11/23 01:15:59 jgg Exp $</version>

 
 <abstract>
 This document provides an overview of how to use the the APT package manager.
 
 <abstract>
 This document provides an overview of how to use the the APT package manager.


@@ -111,9 +111,8 @@ available. This is done with <tt>apt-get update</>. For instance,
 # apt-get update
 Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages
 Get http://llug.sep.bnl.gov/debian/ frozen/contrib Packages
 # apt-get update
 Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages
 Get http://llug.sep.bnl.gov/debian/ frozen/contrib Packages

-Updating package file cache...done
-Updating package status cache...done
-Checking system integrity...ok
+Reading Package Lists... Done
+Building Dependency Tree... Done

 </example>
 
 <p>
 </example>
 
 <p>


@@ -219,10 +218,6 @@ developmental version. <em>non-US</> is only available on some mirrors and
 refers to packages that contain encryption technology or other things that
 cannot be exported from the United States. Importing these packages into the
 US is legal however. 
 refers to packages that contain encryption technology or other things that
 cannot be exported from the United States. Importing these packages into the
 US is legal however. 

-<footnote>As of this writing the non-US distribution has 
-not been created, the only way to access it is by specifying 
-stable/binary-i386/ at this prompt and by specifying a URL ending in 
-debian-non-US </footnote>

 
 <p>
 <example>
 
 <p>
 <example>


@@ -255,6 +250,11 @@ perform the installation using [I]nstall. When using the APT method
 the [C]onfig and [R]emove commands have no meaning, the [I]nstall command
 performs both of them together. 
 
 the [C]onfig and [R]emove commands have no meaning, the [I]nstall command
 performs both of them together. 
 

+<p>
+By default APT will automatically remove the packages once they have been
+sucessfully installed. To change this behavor place <tt>Dselect::clean 
+"prompt";</> in /etc/apt/apt.conf.
+

 </chapt>
                                                                   <!-- }}} -->
 <!-- The Interfaces                                                   {{{ -->
 </chapt>
                                                                   <!-- }}} -->
 <!-- The Interfaces                                                   {{{ -->


@@ -275,61 +275,56 @@ informative status messages so that you can estimate how far along it is and
 how much is left to do.
 
 <!-- ===================================================================== -->
 how much is left to do.
 
 <!-- ===================================================================== -->

-<sect>The Pre-Checks
+<sect>Startup

 
 <p>
 
 <p>

-Before all operations, except update, APT performs a number of checks on the
-systems. These are designed to safe guard the operations it is about to 
-undertake. At any time the full set of checks may be run by performing
-<tt>apt-get check</>. 
+Before all operations, except update, APT performs a number of actions to
+prepare its internal state. It also does some checks of the systems state.
+At any time these operations can be performed by running <tt>apt-get chec</>

 <p>
 <example>
 # apt-get check
 <p>
 <example>
 # apt-get check

-Updating package file cache...done
-Updating package status cache...done
-Checking system integrity...ok
+Reading Package Lists... Done
+Building Dependancy Tree... Done

 </example>
 
 <p>
 </example>
 
 <p>

-The first check is to ensure that the archive package lists are matched to 
-the pre-generated data cache, if they are not then the cache is automatically
-refreshed. This may fail if <tt>apt-get update</> has not been run to 
-synchronize with the <em>Sources</>. The next check verifies that the state of 
-the system matches the cached state and automatically rebuilds the cached
-state if they are not synchronized. This check should never fail and it 
-indicates a serious error if it ever does.
+The first thing it does is read all the package files into memory. APT
+uses a caching scheme so this operation will be faster the second time it
+is run. If some of the package files are not found then they will be ignored
+and a warning will be printed when apt-get exits. 

 
 <p>
 
 <p>

-The final check performs a detailed analysis of the system integrity. It
-checks every dependency of every installed or unpacked package and considers
+The final operation performs a detailed analysis of the systems dependencies. 
+It checks every dependency of every installed or unpacked package and considers

 if it is ok. Should this find a problem then a report will be printed out and
 <prgn>apt-get</> will refuse to run.
 
 <p>
 <example>
 # apt-get check
 if it is ok. Should this find a problem then a report will be printed out and
 <prgn>apt-get</> will refuse to run.
 
 <p>
 <example>
 # apt-get check

-Updating package file cache...done
-Updating package status cache...done
-Checking system integrity...dependency error
+Reading Package Lists... Done
+Building Dependancy Tree... Done

 You might want to run apt-get -f install' to correct these.
 You might want to run apt-get -f install' to correct these.

-Sorry, but the following packages are broken - this means they have unmet
-dependencies:
-  libdbd-mysql-perl: Depends:perl
-  xzx: Depends:xlib6
-  libdbd-msql-perl: Depends:perl
-  mailpgp: Depends:pgp-i Depends:pgp-us
-  xdpkg: Depends:python
-  squake: Depends:quake-lib Depends:quake-lib-stub
-  debmake: Depends:fileutils
-  libreadlineg2: Conflicts:libreadline2
-  ssh: Depends:gmp2 Depends:xlib6g Depends:zlib1g 
+Sorry, but the following packages have unmet dependencies:
+  9fonts: Depends: xlib6g but it is not installed
+  uucp: Depends: mailx but it is not installed
+  blast: Depends: xlib6g (>= 3.3-5) but it is not installed
+  adduser: Depends: perl-base but it is not installed
+  aumix: Depends: libgpmg1 but it is not installed
+  debiandoc-sgml: Depends: sgml-base but it is not installed
+  bash-builtins: Depends: bash (>= 2.01) but 2.0-3 is installed
+  cthugha: Depends: svgalibg1 but it is not installed
+           Depends: xlib6g (>= 3.3-5) but it is not installed
+  libreadlineg2: Conflicts:libreadline2 (<< 2.1-2.1)

 </example>
 
 <p>
 In this example the system has many problems, including a serious problem
 with libreadlineg2. For each package that has unmet dependencies a line
 is printed out indicating the package with the problem and the dependencies
 </example>
 
 <p>
 In this example the system has many problems, including a serious problem
 with libreadlineg2. For each package that has unmet dependencies a line
 is printed out indicating the package with the problem and the dependencies

-that are unmet. For brevity the version inter-relationships are omitted.
+that are unmet. A short explanation of why the package has a dependency
+problem is also included.

 
 <p>
 There are two ways a system can get into a broken state like this. The
 
 <p>
 There are two ways a system can get into a broken state like this. The


@@ -472,6 +467,9 @@ installed packages. It is roughly equivalent to the space required in
 removed then the value may indicate the amount of space that will be
 freed.
 
 removed then the value may indicate the amount of space that will be
 freed.
 

+<p>
+Some other reports can be generated by using the -u option to show packages
+to upgrade, they are similar to the previous examples.

 </sect>
 
 <!-- ===================================================================== -->
 </sect>
 
 <!-- ===================================================================== -->


@@ -483,12 +481,12 @@ status messages,
 <p>
 <example>
 # apt-get update
 <p>
 <example>
 # apt-get update

-Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages
-Get http://llug.sep.bnl.gov/debian/ frozen/contrib Packages
-Get http://llug.sep.bnl.gov/debian/ frozen/main Packages
-Get http://ftp.de.debian.org/debian-non-US/ unstable/binary-i386/ Packages
-Get http://llug.sep.bnl.gov/debian/ frozen/non-free Packages
-11% [Packages `Waiting for file' 0/32.1k 0%] 2203b/s 1m52s
+Get:1 http://ftp.de.debian.org/debian-non-US/ stable/non-US/ Packages
+Get:2 http://llug.sep.bnl.gov/debian/ frozen/contrib Packages
+Hit http://llug.sep.bnl.gov/debian/ frozen/main Packages
+Get:4 http://ftp.de.debian.org/debian-non-US/ unstable/binary-i386/ Packages
+Get:5 http://llug.sep.bnl.gov/debian/ frozen/non-free Packages
+11% [5 frozen/non-free `Waiting for file' 0/32.1k 0%] 2203b/s 1m52s

 </example>
 
 <p>
 </example>
 
 <p>


@@ -503,7 +501,8 @@ inaccuracies.
 The next section of the status line is repeated once for each dowload thread
 and indicates the operation being performed and some usefull information
 about what is happening. Sometimes this section will simply read <em>Forking</>
 The next section of the status line is repeated once for each dowload thread
 and indicates the operation being performed and some usefull information
 about what is happening. Sometimes this section will simply read <em>Forking</>

-which means the OS is loading the download module. The first word after the [ 
+which means the OS is loading the download module. The first word after the [
+is the fetch number as shown on the history lines. The next word

 is the short form name of the object being downloaded. For archives it will
 contain the name of the package that is being fetched.
 
 is the short form name of the object being downloaded. For archives it will
 contain the name of the package that is being fetched.
 

diff --git a/doc/makefile b/doc/makefile
index 5be7c053988194dd55910e6d7c99d9a4feb10591..037c8a2e19f2153d0494912ef5f06e051f37fcf1 100644 (file)
--- a/doc/makefile
+++ b/doc/makefile
@@ -11,5 +11,5 @@ SOURCE = dpkg-tech.sgml design.sgml files.sgml guide.sgml cache.sgml \
 include $(DEBIANDOC_H)
 
 # Man pages
 include $(DEBIANDOC_H)
 
 # Man pages

-SOURCE = apt-cache.8 apt-get.8 apt.8 ftp.conf.5 sources.list.5
+SOURCE = apt-cache.8 apt-get.8 apt.8 sources.list.5

 include $(MANPAGE_H)
 include $(MANPAGE_H)

diff --git a/doc/sources.list.5 b/doc/sources.list.5
index 779f216bf30c3064335a222fbe9a780012744888..be727e9d598aeecaf915ef7179b3239770dcba61 100644 (file)
--- a/doc/sources.list.5
+++ b/doc/sources.list.5
@@ -1,4 +1,4 @@
-.\" $Id: sources.list.5,v 1.1 1998/07/02 02:58:12 jgg Exp $\r
+.\" $Id: sources.list.5,v 1.2 1998/11/23 01:16:01 jgg Exp $\r

 .\" This manpage is copyright (C) 1998 Branden Robinson <branden@debian.org>.\r
 .\" \r
 .\" This is free software; you may redistribute it and/or modify\r
 .\" This manpage is copyright (C) 1998 Branden Robinson <branden@debian.org>.\r
 .\" \r
 .\" This is free software; you may redistribute it and/or modify\r


@@ -160,10 +160,8 @@ debian-non-US directory, and uses only files found under
 unstable/binary-i386 on i386 machines, unstable/binary-m68k on m68k, and so\r
 forth for other supported architectures.\r
 .SH SEE ALSO\r
 unstable/binary-i386 on i386 machines, unstable/binary-m68k on m68k, and so\r
 forth for other supported architectures.\r
 .SH SEE ALSO\r

-.BR apt (8),\r

 .BR apt-cache (8),\r
 .BR apt-get (8),\r
 .BR apt-cache (8),\r
 .BR apt-get (8),\r

-.BR ftp.conf (5)\r

 .SH BUGS\r
 See <http://www.debian.org/Bugs/db/pa/lapt.html>.  If you wish to report a\r
 bug in\r
 .SH BUGS\r
 See <http://www.debian.org/Bugs/db/pa/lapt.html>.  If you wish to report a\r
 bug in\r