Man pages in yodl

Author: jgg
Date: 1998-12-05 22:14:39 GMT
Man pages in yodl

diff --git a/doc/apt-cache.8 b/doc/apt-cache.8
deleted file mode 100644 (file)
index 0292973..0000000
--- a/doc/apt-cache.8
+++ /dev/null
@@ -1,199 +0,0 @@
-.\" 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
-.\" 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 apt-cache 8 "16 June 1998" "Debian GNU/Linux"\r
-.SH NAME\r
-apt-cache \- APT package handling utility \(em cache manipulator\r
-.SH SYNOPSIS\r
-.B apt-cache\r
-.I command cache\r
-.RI [ argument \r
-.IR ... ]\r
-.SH DESCRIPTION\r
-.B apt-cache\r
-performs a variety of operations on APT's package cache.\r
-.I apt-cache\r
-is seldom called directly; instead it is usually invoked internally by\r
-.BR apt-get (8)\r
-or\r
-.BR apt (8).\r
-.PP\r
-.I command\r
-is one of\r
-.RS\r
-.PD 0\r
-.B add\r
-.PP\r
-.B dump\r
-.PP\r
-.B dumpavail\r
-.PP\r
-.B showpkg\r
-.PP\r
-.B stats\r
-.RE\r
-.PD 1\r
-.PP\r
-.I cache\r
-must be a package cache file (for instance,\r
-.IR /var/cache/apt/pkgcache.bin ).\r
-Some\r
-.IR command s\r
-require additional arguments.\r
-.SS add\r
-.B add\r
-adds a new set of package records to\r
-.IR cache .\r
-Remaining arguments are of the form\r
-.IR file : dist : ver ,\r
-where\r
-.I file\r
-is the full path to file in question.\r
-.I dist\r
-and\r
-.I ver\r
-can be any string and are not yet implemented.\r
-.SS dump\r
-.B dump\r
-displays information about all the packages in the cache. See\r
-.B showpkg\r
-below for an explanation of what data is output for each package.\r
-.SS dumpavail\r
-.B dumpavail\r
-generates an\r
-.I available\r
-file suitable for use with\r
-.BR dpkg (8)\r
-based on the information in the cache.\r
-.SS showpkg\r
-.B showpkg\r
-displays information about the packages listed on the command line.     \r
-Remaining arguments are package names. The available versions and       \r
-reverse dependencies of each package listed are listed, as well as      \r
-forward dependencies for each version. Forward (normal) dependencies   \r
-are those packages upon which the package in question depends; reverse  \r
-dependencies are those packages that depend upon the package in         \r
-question. Thus, forward dependencies must be satisfied for a package,  \r
-but reverse dependencies need not be.                                   \r
-For instance,\r
-.B apt-cache showpkg\r
-.I cache\r
-.B libreadline2\r
-would produce output similar to the following:\r
-.PP\r
-.RS\r
-.PD 0\r
-Package: libreadline2\r
-.PP\r
-Versions: 2.1-8,2.1-7,\r
-.PP\r
-Reverse Depends:\r
-.RS\r
-.PP\r
-libreadlineg2,libreadline2\r
-.PP\r
-libreadlineg2,libreadline2\r
-.PP\r
-libreadline2-altdev,libreadline2\r
-.RE\r
-.PP\r
-Dependencies:\r
-.PP\r
-2.1-8 - libc5 ncurses3.0 ldso\r
-.PP\r
-2.1-7 - ldso libc5 ncurses3.0\r
-.RE\r
-.PD 1\r
-.PP\r
-Thus it may be seen that libreadline2, version 2.1-8, depends on libc5,\r
-ncurses3.0, and ldso, which must be installed for libreadline2 to work. In\r
-turn, libreadlineg2 and libreadline2-altdev depend on libreadline2. If\r
-libreadline2 is installed, libc5, ncurses3.0, and ldso must also be\r
-installed; libreadlineg2 and libreadline2-altdev do not have to be\r
-installed.\r
-.SS stats\r
-.B stats\r
-displays some statistics about\r
-.IR cache .\r
-No further arguments are expected. Statistics reported are:\r
-.RS\r
-.TP\r
-.I Total package names\r
-is the number of package names found in the cache.\r
-.TP\r
-.I Normal packages\r
-is the number of regular, ordinary package names; these\r
-are packages that bear a one-to-one correspondence between their names and\r
-the names used by other packages for them in dependencies. The majority of\r
-packages fall into this category.\r
-.TP\r
-.I Pure virtual packages\r
-is the number of packages that exist only as a virtual package name; that\r
-is, packages only "provide" the virtual package name, and no package\r
-actually uses the name. For instance, "mail-transport-agent" in the Debian\r
-GNU/Linux system is a pure virtual package; several packages provide\r
-"mail-transport-agent", but there is no package named "mail-transport-agent".\r
-.TP\r
-.I Single virtual packages\r
-is the number of packages with only one package providing a particular  \r
-virtual package. For instance, in the Debian GNU/Linux system,         \r
-"X11-text-viewer" is a virtual package, but only one package, xless,    \r
-provides "X11-text-viewer".\r
-.TP\r
-.I Mixed virtual packages\r
-is the number of packages that either provide a particular virtual package\r
-or have the virtual package name as the package name. For instance, in the\r
-Debian GNU/Linux system, e2fsprogs is both an actual package, and\r
-provided by the e2compr package.\r
-.TP\r
-.I Missing\r
-is the number of package names that were referenced in a dependency but\r
-were not provided by any package. Missing packages may be in evidence\r
-if a full distribution is not accesssed, or if a package (real or virtual)\r
-has been dropped from the distribution.\r
-.TP\r
-.I Total distinct versions\r
-is the number of package versions found in the cache; this value is\r
-therefore at least equal to the number of total package names. If more than\r
-one distribution (both "stable" and "unstable", for instance), is being\r
-accessed, this value can be considerably larger than the number of total\r
-package names.\r
-.TP\r
-.I Total dependencies\r
-is the number of dependency relationships claimed by all of the packages in\r
-the cache.\r
-.RE\r
-.SH OPTIONS\r
-None.\r
-.SH FILES\r
-None.\r
-.SH SEE ALSO\r
-.BR apt (8),\r
-.BR apt-get (8),\r
-.I /usr/doc/apt/cache*\r
-.SH DIAGNOSTICS\r
-apt-cache returns zero on normal operation, decimal 100 on error.\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-cache ,\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-cache was written by the APT team <apt@packages.debian.org>.\r

diff --git a/doc/apt-cache.8.yo b/doc/apt-cache.8.yo
new file mode 100644 (file)
index 0000000..61248a8
--- /dev/null
+++ b/doc/apt-cache.8.yo
@@ -0,0 +1,203 @@
+mailto(apt@packages.debian.org)
+manpage(apt-cache)(8)(4 Dec 1998)(apt)()
+manpagename(apt-cache)(APT package handling utility -- cache manipulator)
+
+manpagesynopsis()
+apt-cache command [argument ...]
+
+manpagedescription()
+bf(apt-cache) performs a variety of operations on APT's package cache.
+bf(apt-cache) is seldom called directly; instead its operations are
+performed automatically by the other bf(apt) utilities.
+
+em(command) is one of:
+itemize(
+  it() add file1 [file2] [...]
+  it() gencaches
+  it() showpkg package1 [package2] [...]
+  it() stats 
+  it() dump
+  it() dumpavail
+  it() unmet
+  it() check
+)
+
+Unless the -h, or --help option is given one of the above commands
+must be present.
+
+startdit()
+dit(bf(add))
+bf(add) adds the names package index files to the package cache.
+
+dit(bf(gencaches))
+bf(gencaches) performs the same opration as bf(apt-get check). It builds
+the source and package caches from thes sources in bf(/etc/apt/sources.list)
+and from bf(/var/lib/dpkg/status).
+
+dit(bf(showpkg))
+bf(showpkg) displays information about the packages listed on the 
+command line. Remaining arguments are package names. The available versions 
+and reverse dependencies of each package listed are listed, as well as      
+forward dependencies for each version. Forward (normal) dependencies   
+are those packages upon which the package in question depends; reverse  
+dependencies are those packages that depend upon the package in         
+question. Thus, forward dependencies must be satisfied for a package,  
+but reverse dependencies need not be.
+For instance, bf(apt-cache showpkg libreadline2) would produce output similar
+to the following:
+
+verb(
+Package: libreadline2
+
+Versions:
+
+2.1-12(/var/state/apt/lists/debian.midco.net_debian_dists_slink_main_binary-i386_Packages),
+
+Reverse Depends: 
+
+  libreadlineg2,libreadline2
+
+  libreadline2-altdev,libreadline2
+Dependencies:
+
+2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null)) ldso (2 1.9.0-1)
+
+Provides: 
+
+2.1-12 - 
+
+Reverse Provides: 
+)                          
+
+Thus it may be seen that libreadline2, version 2.1-8, depends on libc5,
+ncurses3.0, and ldso, which must be installed for libreadline2 to work. In
+turn, libreadlineg2 and libreadline2-altdev depend on libreadline2. If
+libreadline2 is installed, libc5, ncurses3.0, and ldso must also be
+installed; libreadlineg2 and libreadline2-altdev do not have to be
+installed. For the specific meaning of the remainder of the output it
+is best to consult the apt source code.
+
+dit(bf(stats))
+bf(stats) displays some statistics about bf(cache).
+No further arguments are expected. Statistics reported are:
+itemize(
+   it() bf(Total package names) is the number of package names found in the cache.
+   
+   it() bf(Normal packages) is the number of regular, ordinary package names; these
+   are packages that bear a one-to-one correspondence between their names and
+   the names used by other packages for them in dependencies. The majority of
+   packages fall into this category.
+
+   it() bf(Pure virtual packages) is the number of packages that exist only as 
+   a virtual package name; that is, packages only "provide" the virtual 
+   package name, and no package actually uses the name. For instance, 
+   "mail-transport-agent" in the Debian GNU/Linux system is a pure virtual 
+   package; several packages provide "mail-transport-agent", but there is no 
+   package named "mail-transport-agent".
+   
+   it() bf(Single virtual packages) is the number of packages with only one 
+   package providing a particular virtual package. For instance, in the 
+   Debian GNU/Linux system, "X11-text-viewer" is a virtual package, but only 
+   one package, xless, provides "X11-text-viewer".
+
+   it() bf(Mixed virtual packages) is the number of packages that either provide 
+   a particular virtual package or have the virtual package name as the 
+   package name. For instance, in the Debian GNU/Linux system, e2fsprogs is 
+   both an actual package, and provided by the e2compr package.
+   
+   it() bf(Missing) is the number of package names that were referenced in a 
+   dependency but were not provided by any package. Missing packages may be 
+   in evidence if a full distribution is not accesssed, or if a package 
+   (real or virtual) has been dropped from the distribution.
+
+   it() bf(Total distinct) versions is the number of package versions found in 
+   the cache; this value is therefore at least equal to the number of total 
+   package names. If more than one distribution (both "stable" and "unstable", 
+   for instance), is being accessed, this value can be considerably larger 
+   than the number of total package names.
+
+   it() bf(Total dependencies) is the number of dependency relationships claimed 
+   by all of the packages in the cache.
+)
+
+dit(bf(dump))
+bf(dump) shows a short listing of every package in the cache. It is primarily
+for debugging.
+
+dit(bf(dumpavail))
+bf(dumpavail) prints out an available list to stdout. This is suitable for use
+with df(dpkg) and is used by the bf(dselect) method.
+
+dit(bf(unmet))
+bf(unmet) displays a summary of all unmet dependencies in the package cache.
+
+dit(bf(check))
+bf(check) is a random function for testing certain aspects of the cache.
+Do not use it.
+
+enddit()
+
+manpageoptions()
+
+startdit()
+dit(bf(-h, --help))
+Show a short usage summary.
+
+dit(bf(-p --pkg-cache))
+Select the file to store the package cache. The package cache is the primary
+cache used by all operations.
+
+dit(bf(-s --src-cache))
+Select the file to store the source cache. The source is used only by
+bf(gencaches) and it stores a parsed version of the package information from
+remote sources. When building the package cache the source cache is used
+to advoid reparsing all of the package files.
+
+dit(bf(-q, --quiet))
+Quiet; produces output suitable for logging, omitting progress indicators.
+More qs will produce more quite up to a maximum of 2. You can also use
+bf(-q=#) to set the quiet level, overriding the configuration file.
+
+dit(bf(-i --important))
+Print only important deps; for use with unmet causes only em(Depends) and 
+em(Pre-Depends) relations to be printed.
+
+dit(bf(-c, --config-file))
+Configuration File; Specify a configuration file to use. bf(apt-get) will
+read the default configuration file and then this configuration file. See
+bf(apt.conf(5)) for syntax information.
+
+dit(bf(-o, --option))
+Set a Configuration Option; This will set an arbitary configuration option.
+The syntax is 
+verb(-o Foo::Bar=bar)
+enddit()
+
+manpagefiles()
+itemize(
+  it() /etc/apt/sources.list 
+  locations to fetch packages from
+  
+  it() /var/state/apt/lists/
+  storage area for state information for each package resource specified in
+  
+  it() /var/state/apt/lists/partial/
+  storage area for state information in transit
+)
+
+manpageseealso()
+apt-get (8),
+dpkg (8),
+dselect (8),
+sources.list (5)
+
+manpagediagnostics()
+apt-cache returns zero on normal operation, decimal 100 on error.
+
+manpagebugs()
+See http://www.debian.org/Bugs/db/pa/lapt.html.  If you wish to report a
+bug in bf(apt-cache), please see bf(/usr/doc/debian/bug-reporting.txt)
+or the bf(bug(1)) command.
+
+manpageauthor()
+apt-get was written by the APT team <apt@packages.debian.org>.

diff --git a/doc/apt-cdrom.8.yo b/doc/apt-cdrom.8.yo
new file mode 100644 (file)
index 0000000..27af39f
--- /dev/null
+++ b/doc/apt-cdrom.8.yo
@@ -0,0 +1,103 @@
+mailto(apt@packages.debian.org)
+manpage(apt-cdrom)(8)(4 Dec 1998)(apt)()
+manpagename(apt-cdrom)(APT CDROM managment utility)
+
+manpagesynopsis()
+apt-cdrom command
+
+manpagedescription()
+bf(apt-cdrom) is used to add a new CDROM to APTs list of available sources.
+bf(apt-cdrom) takes care of determining the structure of the disc as well
+as correcting for several possible mis-burns and verifying the index files.
+It is necessary to use bf(apt-cdrom) to add CDs to the APT system, it cannot
+be done by hand. Furthermore each disk in a multi-cd set must be inserted
+and scanned seperately to account for possible mis-burns.
+
+em(command) is one of:
+itemize(
+  it() add 
+)
+
+Unless the -h, or --help option is given one of the above commands
+must be present.
+
+startdit()
+dit(bf(add))
+bf(add) is used to add a new disc to the source list. It will unmount the
+CDROM device, prompt for a disk to be inserted and then procceed to scan it
+and copy the index files. If the disc does not have a proper bf(.disk/) 
+directory you will be prompted for a descriptive title.
+
+APT uses a CDROM ID to track which disc is currently in the drive and
+maintains a database of these IDs in bf(/var/state/apt/cdroms.list)
+
+enddit()
+
+manpageoptions()
+
+startdit()
+dit(bf(-h, --help))
+Show a short usage summary.
+
+dit(bf(-d --cdrom))
+Mount point; specify the location to mount the cdrom. This mount point must
+be listed in bf(/etc/fstab) and propely configured.
+
+dit(bf(-r --rename))
+Rename a disc; change the label of a disk or override the disks given label.
+This option will cause bf(apt-cdrom) to prompt for a new label
+
+dit(bf(-m, --no-mount))
+No mounting; prevent bf(apt-cdrom) from mounting and unmounting the mount
+point.
+
+dit(bf(-f, --fast))
+Fast Copy; Assume the package files are valid and do not check every package.
+This option should be used only if bf(apt-cdrom) has been run on this disc
+before and did not detect any errors.
+ 
+dit(bf(-n --just-print, --recon, --no-act))
+No Changes; Do not change the sources.list and do not write package files. 
+Everything is still checked however.
+
+dit(bf(-c, --config-file))
+Configuration File; Specify a configuration file to use. bf(apt-get) will
+read the default configuration file and then this configuration file. See
+bf(apt.conf(5)) for syntax information.
+
+dit(bf(-o, --option))
+Set a Configuration Option; This will set an arbitary configuration option.
+The syntax is 
+verb(-o Foo::Bar=bar)
+enddit()
+
+manpagefiles()
+itemize(
+  it() /etc/apt/sources.list 
+  locations to fetch packages from
+  
+  it() /var/state/apt/lists/
+  storage area for state information for each package resource specified in
+  
+  it() /var/state/apt/lists/partial/
+  storage area for state information in transit
+  
+  it() /var/state/apt/cdroms.list
+  list of cdrom IDs and names.
+)
+
+manpageseealso()
+apt-get (8),
+sources.list (5),
+apt.conf(5)
+
+manpagediagnostics()
+apt-cdrom returns zero on normal operation, decimal 100 on error.
+
+manpagebugs()
+See http://www.debian.org/Bugs/db/pa/lapt.html.  If you wish to report a
+bug in bf(apt-cache), please see bf(/usr/doc/debian/bug-reporting.txt)
+or the bf(bug(1)) command.
+
+manpageauthor()
+apt-get was written by the APT team <apt@packages.debian.org>.

diff --git a/doc/apt-get.8 b/doc/apt-get.8
deleted file mode 100644 (file)
index 48e453d..0000000
--- a/doc/apt-get.8
+++ /dev/null
@@ -1,249 +0,0 @@
-.\" $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
-.\" 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 apt-get 8 "16 June 1998" "Debian GNU/Linux"\r
-.SH NAME\r
-apt-get \- APT package handling utility \(em command-line interface\r
-.SH SYNOPSIS\r
-.B apt-get\r
-.RI [ options ]\r
-.RI [ command ]\r
-.RI [ package\r
-.IR ... ]\r
-.SH DESCRIPTION\r
-.B apt-get\r
-is the command-line tool for handling packages, and may be considered the\r
-user's "back-end" to\r
-.BR apt (8).\r
-Use\r
-.BR apt (8)\r
-if the usage of apt-get does not seem intuitive.\r
-.PP\r
-.I command\r
-is one of\r
-.RS\r
-.PD 0\r
-.B update\r
-.PP\r
-.B upgrade\r
-.PP\r
-.B dselect-upgrade\r
-.PP\r
-.B dist-upgrade\r
-.PP\r
-.B install\r
-.PP\r
-.B check\r
-.PP\r
-.B clean\r
-.RE\r
-.PD 1\r
-.PP\r
-Unless one of the\r
-.IR -h ,\r
-.IR --help ,\r
-.IR -f ,\r
-or\r
-.I --fix-broken\r
-options is given, one of the above commands must be present. Only the\r
-.B install\r
-command requires any further arguments.\r
-.SS update\r
-.B update\r
-is used to resynchronize the package overview files from their\r
-sources. The overviews of available packages are fetched from the\r
-location(s) specified in\r
-.IR /etc/apt/sources.list .\r
-For example, when using a Debian archive, this command retrieves and\r
-scans the\r
-.I Packages.gz\r
-files, so that information about new and updated packages is available. An\r
-.B update\r
-should always be performed before an\r
-.B upgrade\r
-or\r
-.BR dist-upgrade .\r
-.SS upgrade\r
-.B upgrade\r
-is used to install the newest versions of all packages currently installed\r
-on the system from the sources enumerated in\r
-.IR /etc/apt/sources.list .\r
-Packages currently installed with new versions available are retrieved\r
-and upgraded; under no circumstances are currently installed packages\r
-removed, or packages not already installed retrieved and installed. New\r
-versions of currently installed packages that cannot be upgraded without\r
-changing the install status of another package will be left at their\r
-current version. An\r
-.B update\r
-must be performed first so that\r
-.B apt-get\r
-knows that new versions of packages are available.\r
-.SS dselect-upgrade\r
-.B dselect-upgrade\r
-is used in conjunction with the traditional Debian GNU/Linux packaging\r
-front-end,\r
-.BR dselect (8). " dselect-upgrade"\r
-follows the changes made by\r
-.B dselect\r
-to the\r
-.I Status\r
-field of available packages, and performs the actions necessary to realize\r
-that state (for instance, the removal of old and the installation of new\r
-packages).\r
-.B dselect-upgrade\r
-does not attempt to intelligently address dependency issues as\r
-.B dist-upgrade\r
-or\r
-.B install\r
-do. If any dependency problems arise,\r
-.B apt-get\r
-aborts without performing any of the actions requested, even those\r
-without problems.\r
-.B dselect-upgrade\r
-is only useful to users of\r
-.B dselect\r
-and the\r
-.I .deb\r
-package file format. The\r
-.I /etc/apt/sources.list\r
-file contains a list of locations from which to retrieve desired package\r
-files.\r
-.SS dist-upgrade\r
-.BR dist-upgrade ,\r
-in addition to performing the function of\r
-.BR upgrade ,\r
-also intelligently handles changing dependencies with new versions of\r
-packages;\r
-.B apt-get\r
-has a "smart" conflict resolution system, and it will attempt to upgrade\r
-the most important packages at the expense of less important ones if\r
-necessary. The\r
-.I /etc/apt/sources.list\r
-file contains a list of locations from which to retrieve desired package\r
-files.\r
-.SS install\r
-.B install\r
-is followed by one or more\r
-.I packages\r
-desired for installation. Each\r
-.I package\r
-is a package name, not a fully qualified filename (for instance, in a\r
-Debian GNU/Linux system,\r
-.I lsdo\r
-would be the argument provided, not\r
-.IR ldso_1.9.6-2.deb ).\r
-All packages required by the package(s) specified for installation will\r
-also be retrieved and installed. The\r
-.I /etc/apt/sources.list\r
-file is used to locate the desired packages. If a hyphen is appended to\r
-the package name (with no intervening space), the identified package will\r
-be removed if it is installed. This latter feature may be used to override\r
-decisions made by apt-get's conflict resolution system.\r
-.SS check\r
-.B check\r
-is a diagnostic tool; it updates the package cache and checks for broken\r
-packages.\r
-.SS clean\r
-.B clean\r
-clears out the local repository of retrieved package files. It removes\r
-everything but the lock file from\r
-.I /var/cache/apt/archives/\r
-and\r
-.IR /var/cache/apt/archives/partial/ .\r
-When APT is used as a\r
-.BR dselect (8)\r
-method,\r
-.B\r
-clean\r
-is run automatically.  Those who do not use dselect will likely want to\r
-run\r
-.B\r
-apt-get clean\r
-from time to time to free up disk space.\r
-.SH OPTIONS\r
-.TP\r
-.IR \-d , " --download-only"\r
-Download only; package files are only retrieved, not unpacked or installed.\r
-.TP\r
-.IR \-f , " --fix-broken"\r
-Fix; attempt to correct a system with broken dependencies in            \r
-place. This option may be used alone or in conjunction with any of the  \r
-command actions, and is sometimes necessary when running APT for the    \r
-first time; APT itself does not allow broken package dependencies to    \r
-exist on a system. It is possible that a system's dependency structure  \r
-can be so corrupt as to require manual intervention (which usually      \r
-means using dselect or dpkg --remove to eliminate some of the offending \r
-packages). Use of this option together with -m is discouraged.          \r
-.TP\r
-.IR \-h , " --help"\r
-Help; display a helpful usage message and exit.\r
-.TP\r
-.IR \-m , " --ignore-missing"\r
-Ignore missing packages; If packages cannot be retrieved or fail the    \r
-integrity check after retrieval (corrupted package files), hold back    \r
-those packages and handle the result. Use of this option together with  \r
--f is discouraged.                                                      \r
-.TP\r
-.IR \-q , " --silent"\r
-Quiet; produces output suitable for logging, omitting progress indicators.\r
-.TP\r
-.I \-qq\r
-Very quiet; no output except for errors.\r
-.TP\r
-.IR \-s , " --simulate" , " --just-print" , " --dry-run" , " --recon " , " --no-act"\r
-No action; perform a simulation of events that would occur but do not\r
-actually change the system.\r
-.TP\r
-.IR \-y , " --yes" , " --assume-yes"\r
-Automatic yes to prompts; assume "yes" as answer to all prompts and run\r
-non-interactively.\r
-.SH FILES\r
-.TP\r
-.I /etc/apt/sources.list\r
-see\r
-.BR sources.list (5)\r
-.TP\r
-.I /var/cache/apt/archives/\r
-storage area for retrieved package files\r
-.TP\r
-.I /var/cache/apt/archives/partial/\r
-storage area for package files in transit\r
-.TP\r
-.I /var/state/apt/lists/\r
-storage area for state information for each package resource specified in\r
-.I /etc/apt/sources.list\r
-.TP\r
-.I /var/state/apt/lists/partial/\r
-storage area for state information in transit\r
-.SH SEE ALSO\r
-.BR apt-cache (8),\r
-.BR dpkg (8),\r
-.BR dselect (8),\r
-.BR sources.list (5)\r
-.SH DIAGNOSTICS\r
-apt-get returns zero on normal operation, decimal 100 on error.\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-get was written by the APT team <apt@packages.debian.org>.\r

diff --git a/doc/apt-get.8.yo b/doc/apt-get.8.yo
index 32b1e613223047c4b194cf8fd56de0f23d701fc1..f77795a7bef73ad808a3cb3ca62b09dd84b01c25 100644 (file)
--- a/doc/apt-get.8.yo
+++ b/doc/apt-get.8.yo
@@ -16,14 +16,14 @@ itemize(
   it() upgrade
   it() dselect-upgrade
   it() dist-upgrade
   it() upgrade
   it() dselect-upgrade
   it() dist-upgrade

-  it() install
-  it() remove
+  it() install package1 [package2] [...]
+  it() remove package1 [package2] [...]

   it() check
   it() clean
 )
 
 Unless the -h, or --help option is given one of the above commands
   it() check
   it() clean
 )
 
 Unless the -h, or --help option is given one of the above commands

-must be present. Only the install command requires any further arguments.
+must be present.

 
 startdit()
 dit(bf(update))
 
 startdit()
 dit(bf(update))


@@ -73,6 +73,11 @@ hyphen is appended to the package name (with no intervening space), the
 identified package will be removed if it is installed. This latter feature 
 may be used to override decisions made by apt-get's conflict resolution system.
 
 identified package will be removed if it is installed. This latter feature 
 may be used to override decisions made by apt-get's conflict resolution system.
 

+dit(bf(remove))
+bf(remove) is identical to bf(install) except that packages are removed
+instead of installed. If a plus sign is appended to the package name (with no
+intervening space), the identified package will be installed.
+

 dit(bf(check))
 bf(check) is a diagnostic tool; it updates the package cache and checks for 
 brokenpackages.
 dit(bf(check))
 bf(check) is a diagnostic tool; it updates the package cache and checks for 
 brokenpackages.


@@ -112,7 +117,7 @@ integrity check after retrieval (corrupted package files), hold back
 those packages and handle the result. Use of this option together with  
 -f is discouraged.
 
 those packages and handle the result. Use of this option together with  
 -f is discouraged.
 

-dit(bf(-q, --silent))
+dit(bf(-q, --quiet))

 Quiet; produces output suitable for logging, omitting progress indicators.
 More qs will produce more quite up to a maximum of 2. You can also use
 bf(-q=#) to set the quiet level, overriding the configuration file.
 Quiet; produces output suitable for logging, omitting progress indicators.
 More qs will produce more quite up to a maximum of 2. You can also use
 bf(-q=#) to set the quiet level, overriding the configuration file.


@@ -156,6 +161,7 @@ dit(bf(-o, --option))
 Set a Configuration Option; This will set an arbitary configuration option.
 The syntax is 
 verb(-o Foo::Bar=bar)
 Set a Configuration Option; This will set an arbitary configuration option.
 The syntax is 
 verb(-o Foo::Bar=bar)

+enddit()

 
 manpagefiles()
 itemize(
 
 manpagefiles()
 itemize(


@@ -176,10 +182,11 @@ itemize(
 )
 
 manpageseealso()
 )
 
 manpageseealso()

-apt-cache (8),
-dpkg (8),
-dselect (8),
-sources.list (5)
+apt-cache(8),
+dpkg(8),
+dselect(8),
+sources.list(5),
+The APT Users Guide in /usr/doc/apt/

 
 manpagediagnostics()
 apt-get returns zero on normal operation, decimal 100 on error.
 
 manpagediagnostics()
 apt-get returns zero on normal operation, decimal 100 on error.

diff --git a/doc/sources.list.5 b/doc/sources.list.5
deleted file mode 100644 (file)
index be727e9..0000000
--- a/doc/sources.list.5
+++ /dev/null
@@ -1,175 +0,0 @@
-.\" $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
-.\" 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 sources.list 5 "16 June 1998" "Debian GNU/Linux"\r
-.SH NAME\r
-sources.list \- package resource list for APT\r
-.SH DESCRIPTION\r
-The package resource list is used to locate archives of the package\r
-distribution system in use on the system. At this time, this manual page\r
-documents only the packaging system used by the Debian GNU/Linux system.\r
-.PP\r
-The source list is designed to support any number of active sources and a\r
-variety of source media. The file lists one source per line, with the\r
-most preferred source listed first. The format of each line is:\r
-.I type uri args\r
-The first item,\r
-.IR type ,\r
-determines the format for\r
-.IR args .\r
-.I uri\r
-is a Universal Resource Identifier (URI), which is a superset of the more\r
-specific and well-known Universal Resource Locator, or URL.\r
-.SS The deb type\r
-The\r
-.B deb\r
-type describes a typical two-level Debian archive,\r
-.IR distribution / component .\r
-Typically,\r
-.I distribution\r
-is one of\r
-.BR stable ,\r
-.BR unstable ,\r
-or\r
-.BR frozen ,\r
-while component is one of\r
-.BR main ,\r
-.BR contrib ,\r
-.BR non-free ,\r
-or\r
-.BR non-us .\r
-The format for a\r
-.I sources.list\r
-entry using the\r
-.B deb\r
-type is:\r
-.RS\r
-deb\r
-.I uri distribution\r
-.RI [ component\r
-.I ...\r
-]\r
-.RE\r
-The URI for the\r
-.B deb\r
-type must specify the base of the Debian distribution, from which\r
-.B APT\r
-will find the information it needs.\r
-.I distribution\r
-can specify an exact path, in which case the\r
-.IR component s\r
-must be omitted and\r
-.I distribution\r
-must end with a slash (/). This is useful for when only a particular\r
-sub-section of the archive denoted by the URI is of interest.\r
-If\r
-.I distribution\r
-does not specify an exact path, at least one\r
-.I component\r
-must be present.\r
-.PP\r
-.I distribution\r
-may also contain a variable, \r
-.BR $(ARCH) ,\r
-which expands to the Debian architecture (i386, m68k, powerpc, ...)     \r
-used on the system. This permits archiecture-independent                \r
-.I sources.list\r
-files to be used.\r
-.PP\r
-Since only one distribution can be specified per line it may be necessary\r
-to have multiple lines for the same URI, if a subset of all available\r
-distributions or components at that location is desired.\r
-.B APT\r
-will sort the URI list after it has generated a complete set internally,\r
-and will collapse multiple references to the same Internet host, for\r
-instance, into a single connection, so that it does not inefficiently\r
-establish an FTP connection, close it, do something else, and then\r
-re-establish a connection to that same host. This feature is useful\r
-for accessing busy FTP sites with limits on the number of simultaneous\r
-anonymous users.\r
-.PP\r
-It is important to list sources in order of preference, with the most\r
-preferred source listed first. Typically this will result in sorting\r
-by speed from fastest to slowest (CD-ROM followed by hosts on a local\r
-network, followed by distant Internet hosts, for example).\r
-.SS URI specification\r
-The three currently recognized URI types are file, http, and ftp.\r
-.IP file\r
-The file scheme allows an arbitrary directory in the file system to be\r
-considered an archive. This is useful for NFS mounts and local mirrors or\r
-archives.\r
-.IP http\r
-The http scheme specifies an HTTP server for the archive. If an environment\r
-variable\r
-.B $http_proxy\r
-is set with the format\r
-.\" Ugly hackery ahead, nroff doesn't like three different typefaces in a\r
-.\" row with no spaces between anything.\r
-.BI http:// server : port /\c\r
-, the proxy server specified in\r
-.B $http_proxy\r
-will be used. Users of\r
-authenticated HTTP/1.1 proxies may use a string of the format\r
-.BI http:// user : pass @ server : port /\c\r
-.\" For some reason, starting the next line with \. didn't work. So we kludge.\r
-\&. Note that this is an insecure method of authentication.\r
-.IP ftp\r
-The ftp scheme specifies an FTP server for the archive. APT's FTP behavior\r
-is highly configurable; for more information see the\r
-.BR ftp.conf (5)\r
-manual page.\r
-.SH EXAMPLES\r
-.IP "deb file:/home/jason/debian stable main contrib non-free"\r
-Uses the archive stored locally (or NFS mounted) at\r
-.I /home/jason/debian\r
-for stable/main, stable/contrib, and stable/non-free.\r
-.IP "deb file:/home/jason/debian unstable main contrib non-free"\r
-As above, except this uses the unstable (development) distribution.\r
-.IP "deb http://www.debian.org/archive stable main"\r
-Uses HTTP to access the archive at www.debian.org, and uses only the\r
-stable/main area.\r
-.IP "deb ftp://ftp.debian.org/debian stable contrib"\r
-Uses FTP to access the archive at ftp.debian.org, under the debian\r
-directory, and uses only the stable/contrib area.\r
-.IP "deb ftp://ftp.debian.org/debian unstable contrib"\r
-Uses FTP to access the archive at ftp.debian.org, under the debian\r
-directory, and uses only the unstable/contrib area. If this line appears as\r
-well as the one in the previous example in\r
-.IR sources.list ,\r
-a single FTP session will be used for both resource lines.\r
-.IP "deb ftp://nonus.debian.org/debian-non-US unstable/binary-i386/"\r
-Uses FTP to access the archive at nonus.debian.org, under the debian-non-US\r
-directory, and uses only files found under unstable/binary-i386.\r
-.IP "deb http://ftp.de.debian.org/debian-non-US unstable/binary-$(ARCH)/"\r
-Uses HTTP to access the archive at nonus.debian.org, under the\r
-debian-non-US directory, and uses only files found under\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-cache (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/sources.list.5.yo b/doc/sources.list.5.yo
new file mode 100644 (file)
index 0000000..588c67d
--- /dev/null
+++ b/doc/sources.list.5.yo
@@ -0,0 +1,128 @@
+mailto(apt@packages.debian.org)
+manpage(sources.list)(5)(5 Dec 1998)(apt)()
+manpagename(sources.list)(package resource list for APT)
+
+manpagedescription()
+The package resource list is used to locate archives of the package
+distribution system in use on the system. At this time, this manual page
+documents only the packaging system used by the Debian GNU/Linux system.
+
+The source list is designed to support any number of active sources and a
+variety of source media. The file lists one source per line, with the
+most preferred source listed first. The format of each line is:
+em(type uri args) The first item, em(type), determines the format for
+em(args). em(uri) is a Universal Resource Identifier (URI), which is a 
+superset of the more specific and well-known Universal Resource Locator, or 
+URL.
+
+manpagesection(The deb type)
+The bf(deb) type describes a typical two-level Debian archive,
+em(distribution/component). Typically, em(distribution) is one of
+em(stable), em(unstable), or em(frozen), while component is one of
+em(main), em(contrib), em(non-free), or em(non-us).
+The format for a bf(sources.list) entry using the em(deb)
+type is:
+verb(deb uri distribution [component1] [componenent2] [...])
+The URI for the em(deb) type must specify the base of the Debian distribution, 
+from which bf(APT) will find the information it needs. em(distribution)
+can specify an exact path, in which case the em(component)s
+must be omitted and bf(distribution) must end with a slash (/). This is 
+useful for when only a particular sub-section of the archive denoted by the 
+URI is of interest. If bf(distribution) does not specify an exact path, at 
+least one bf(component) must be present.
+
+bf(distribution) may also contain a variable, bf($(ARCH)),
+which expands to the Debian architecture (i386, m68k, powerpc, ...)     
+used on the system. This permits archiecture-independent                
+bf(sources.list) files to be used. In general this is only of interest
+when specifying an exact path, bf(APT) will automatically generate a URI
+with the current architecture otherwise.
+
+Since only one distribution can be specified per line it may be necessary
+to have multiple lines for the same URI, if a subset of all available
+distributions or components at that location is desired.
+bf(APT) will sort the URI list after it has generated a complete set 
+internally, and will collapse multiple references to the same Internet host, 
+for instance, into a single connection, so that it does not inefficiently
+establish an FTP connection, close it, do something else, and then
+re-establish a connection to that same host. This feature is useful
+for accessing busy FTP sites with limits on the number of simultaneous
+anonymous users. bf(APT) also parallizes connections to different hosts
+to more effectively deal with sites with low bandwidth.
+
+It is important to list sources in order of preference, with the most
+preferred source listed first. Typically this will result in sorting
+by speed from fastest to slowest (CD-ROM followed by hosts on a local
+network, followed by distant Internet hosts, for example).
+
+manpagesection(URI specification)
+The currently recognized URI types are cdrom, file, http, and ftp.
+
+startdit()
+dit(bf(file))
+The file scheme allows an arbitrary directory in the file system to be
+considered an archive. This is useful for NFS mounts and local mirrors or
+archives.
+
+dit(bf(cdrom))
+The cdrom scheme allows bf(APT) to use a local CDROM drive with media
+swapping. Use the bf(apt-cdrom(8)) program to create cdrom entires in the
+source list.
+
+dit(bf(http))
+The http scheme specifies an HTTP server for the archive. If an environment
+variable bf($http_proxy) is set with the format 
+bf(http://server:port/), the proxy server specified in
+bf($http_proxy) will be used. Users of authenticated HTTP/1.1 proxies may 
+use a string of the format bf(http://user:pass@server:port/)
+Note that this is an insecure method of authentication.
+
+dit(bf(ftp))
+The ftp scheme specifies an FTP server for the archive. APT's FTP behavior
+is highly configurable; for more information see the
+bf(apt.conf(5)) manual page.
+enddit()
+
+manpagesection(EXAMPLES)
+Uses the archive stored locally (or NFS mounted) at /home/jason/debian
+for stable/main, stable/contrib, and stable/non-free.
+quote("deb file:/home/jason/debian stable main contrib non-free")
+
+As above, except this uses the unstable (development) distribution.
+quote("deb file:/home/jason/debian unstable main contrib non-free")
+
+Uses HTTP to access the archive at www.debian.org, and uses only the
+stable/main area.
+quote("deb http://www.debian.org/archive stable main")
+
+Uses FTP to access the archive at ftp.debian.org, under the debian
+directory, and uses only the stable/contrib area.
+quote("deb ftp://ftp.debian.org/debian stable contrib")
+
+Uses FTP to access the archive at ftp.debian.org, under the debian
+directory, and uses only the unstable/contrib area. If this line appears as
+well as the one in the previous example in bf(sources.list),
+a single FTP session will be used for both resource lines.
+quote("deb ftp://ftp.debian.org/debian unstable contrib")
+
+Uses FTP to access the archive at nonus.debian.org, under the debian-non-US
+directory, and uses only files found under unstable/binary-i386.
+quote("deb ftp://nonus.debian.org/debian-non-US unstable/binary-i386/")
+
+Uses HTTP to access the archive at nonus.debian.org, under the
+debian-non-US directory, and uses only files found under
+unstable/binary-i386 on i386 machines, unstable/binary-m68k on m68k, and so
+forth for other supported architectures.
+quote("deb http://ftp.de.debian.org/debian-non-US unstable/binary-$(ARCH)/")
+
+manpageseealso()
+apt-cache (8),
+apt.conf (5)
+
+manpagebugs()
+See http://www.debian.org/Bugs/db/pa/lapt.html.  If you wish to report a
+bug in bf(apt-get), please see bf(/usr/doc/debian/bug-reporting.txt)
+or the bf(bug(1)) command.
+
+manpageauthor()
+apt-get was written by the APT team <apt@packages.debian.org>.