start adding apt.8.xml

1 files changed, 128 insertions, 0 deletions

diff --git a/doc/apt.8.xml b/doc/apt.8.xml
new file mode 100644
index 000000000..0340e043f
--- /dev/null
+++ b/doc/apt.8.xml
@@ -0,0 +1,128 @@
+<?xml version="1.0" encoding="utf-8" standalone="no"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+
+<!ENTITY % aptent SYSTEM "apt.ent">
+%aptent;
+
+<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
+%aptverbatiment;
+
+]>
+
+<refentry>
+
+ <refentryinfo>
+   &apt-author.jgunthorpe;
+   &apt-author.team;
+   &apt-email;
+   &apt-product;
+   <!-- The last update date -->
+   <date>2013-11-25T00:00:00Z</date>
+ </refentryinfo>
+ 
+ <refmeta>
+   <refentrytitle>apt</refentrytitle>
+   <manvolnum>8</manvolnum>
+   <refmiscinfo class="manual">APT</refmiscinfo>
+ </refmeta>
+ 
+ <!-- Man page title -->
+ <refnamediv>
+    <refname>apt</refname>
+    <refpurpose>APT package -- command-line interface</refpurpose>
+ </refnamediv>
+
+ &synopsis-command-apt;
+
+ <refsect1><title>Description</title>
+   <para><command>apt</command> is the command-line tool for handling packages. It provides a commandline interface for the package management of the system.
+
+   See also &apt-get; and &apt-cache; for more low-level command options.
+   </para>
+
+   <variablelist>
+     <varlistentry><term><option>update</option></term>
+     <listitem><para><literal>update</literal> is used to
+     resynchronize the package index files from their sources.
+     </para></listitem>
+   </varlistentry>
+     
+     <varlistentry><term><option>upgrade</option></term>
+     <listitem><para><literal>upgrade</literal> is used to install the
+     newest versions of all packages currently installed on the system
+     from the sources enumerated in
+     <filename>/etc/apt/sources.list</filename>. New package will be
+     installed, but existing package will never removed.
+     </para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><option>install</option></term>
+     <listitem>
+	 <para><literal>install</literal> is followed by one or more 
+	 package names desired for installation or upgrading. 
+	 </para>
+
+     <para>A specific version of a package can be selected for installation by 
+     following the package name with an equals and the version of the package 
+     to select. This will cause that version to be located and selected for
+     install. Alternatively a specific distribution can be selected by 
+     following the package name with a slash and the version of the 
+     distribution or the Archive name (stable, testing, unstable).</para>
+     </listitem>
+     </varlistentry>
+
+     <varlistentry><term><option>remove</option></term>
+     <listitem><para><literal>remove</literal> is identical to <literal>install</literal> except that packages are 
+	 removed instead of installed. Note that removing a package leaves its
+	 configuration files on the system. If a plus sign is appended to the package 
+     name (with no intervening space), the identified package will be 
+     installed instead of removed.</para></listitem>
+     </varlistentry>
+
+   </variablelist>
+ </refsect1>
+ 
+ <refsect1><title>options</title>
+   &apt-cmdblurb;
+
+   <variablelist>
+
+     &apt-commonoptions;
+     
+   </variablelist>
+ </refsect1>
+
+ <refsect1><title>Differences to &apt-get;</title>
+ <para>The <command>apt</command> command is meant to be pleasant for
+ end users and does not need to be backward compatilbe like
+ &apt-get;. Therefore some options are different:
+ 
+ <itemizedlist>
+   <listitem>The option <literal>DPkgPM::Progress-Fancy</literal> is enabled.
+   </listitem>
+   <listitem>The option <literal>APT::Color</literal> is enabled.
+   </listitem>
+   <listitem>A new <literal>list</literal> command is available
+   similar to <literal>dpkg --list</literal>.
+   </listitem>
+   <listitem>The option <literal>upgrade</literal> has
+   <literal>--with-new-pkgs</literal> enabled by default.
+   </listitem>
+
+ </itemizedlist>
+
+ </para>
+ </refsect1>
+
+ <refsect1><title>See Also</title>
+   <para>&apt-get; &apt-cache;, &sources-list;,
+   &apt-conf;, &apt-config;, 
+   The APT User's guide in &guidesdir;, &apt-preferences;, the APT Howto.</para>
+ </refsect1>
+
+ <refsect1><title>Diagnostics</title>
+   <para><command>apt</command> returns zero on normal operation, decimal 100 on error.</para>
+ </refsect1>
+ &manbugs;
+</refentry>