Merge remote-tracking branch 'mvo/feature/apt-manpage' into debian/sid

Conflicts:
	cmdline/apt.cc

6 files changed, 216 insertions, 10 deletions

diff --git a/doc/apt-verbatim.ent b/doc/apt-verbatim.ent
index 1d98362c1..5d0d4c9f0 100644
--- a/doc/apt-verbatim.ent
+++ b/doc/apt-verbatim.ent
@@ -247,6 +247,24 @@
 <!ENTITY synopsis-param-filename "<filename><replaceable>&synopsis-filename;</replaceable></filename>">
 <!ENTITY synopsis-help "<arg choice='plain'><group choice='req'><arg choice='plain'>-v</arg><arg choice='plain'>--version</arg></group></arg>
 	<arg choice='plain'><group choice='req'><arg choice='plain'>-h</arg><arg choice='plain'>--help</arg></group></arg>">
+<!ENTITY synopsis-command-apt "<refsynopsisdiv><cmdsynopsis>
+	<command>apt</command>
+	<arg><option>-h</option></arg>
+	&synopsis-arg-option;
+	&synopsis-arg-config;
+	&synopsis-arg-target-release;
+	&synopsis-arg-architecture;
+	<group choice='req'>
+		<arg choice='plain'>list</arg>
+		<arg choice='plain'>search</arg>
+		<arg choice='plain'>show</arg>
+		<arg choice='plain'>update</arg>
+		<arg choice='plain'>upgrade</arg>
+		<arg choice='plain'>install &synopsis-arg-pkgver;</arg>
+		<arg choice='plain'>remove &synopsis-arg-pkg;</arg>
+		&synopsis-help;
+	</group>
+</cmdsynopsis></refsynopsisdiv>">
 <!ENTITY synopsis-command-apt-get "<refsynopsisdiv><cmdsynopsis>
 	<command>apt-get</command>
 	<arg><option>-asqdyfmubV</option></arg>
diff --git a/doc/apt.8 b/doc/apt.7
index d84a3b4dd..5cdfa781e 100644
--- a/doc/apt.8
+++ b/doc/apt.7
@@ -14,13 +14,15 @@
 .\" License along with APT; if not, write to the Free Software
 .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 
 .\" 02111-1307 USA
-.TH apt 8 "16 June 1998" "Debian"
+.TH apt 7 "16 June 1998" "Debian"
 .SH NAME
 apt \- Advanced Package Tool
 .SH SYNOPSIS
 .B apt
 .SH DESCRIPTION
-APT is a management system for software packages. For normal day to day
+APT is a management system for software packages. 
+
+For normal day to day
 package management there are several frontends available, such as
 .BR aptitude (8)
 for the command line or
@@ -29,6 +31,7 @@ for the X Window System. Some options are only implemented in
 .BR apt-get (8)
 though.
 .SH SEE ALSO
+.BR apt (8),
 .BR apt-cache (8),
 .BR apt-get (8),
 .BR apt.conf (5),
diff --git a/doc/apt.8.xml b/doc/apt.8.xml
new file mode 100644
index 000000000..716b685f6
--- /dev/null
+++ b/doc/apt.8.xml
@@ -0,0 +1,184 @@
+<?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.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>command-line interface</refpurpose>
+ </refnamediv>
+
+ &synopsis-command-apt;
+
+ <refsect1><title>Description</title>
+   <para><command>apt</command> (Advanced Package Tool) 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>list</option></term>
+     <listitem><para><literal>list</literal> is used to
+     display a list of packages. It supports shell pattern for matching
+     package names and the following options:
+       <option>--installed</option>
+       <option>--upgradable</option>
+       <option>--all-versions</option>
+     are supported.
+     </para></listitem>
+     </varlistentry>
+     
+     <varlistentry><term><option>search</option></term>
+     <listitem><para><literal>search</literal> searches for the given
+     term(s) and display matching packages.
+     </para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><option>show</option></term>
+     <listitem><para><literal>show</literal> shows the package information
+     for the given package(s).
+     </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>
+
+     <varlistentry><term><option>edit-sources</option></term>
+     <listitem><para><literal>edit-sources</literal> lets you edit
+     your sources.list file and provides basic sanity checks.
+     </para></listitem>
+     </varlistentry>
+
+     <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>full-upgrade</option></term>
+     <listitem><para><literal>full-upgrade</literal> performs the
+     function of upgrade but may also remove installed packages
+     if that is required in order to resolve a package conflict.
+     </para></listitem>
+     </varlistentry>
+
+
+   </variablelist>
+ </refsect1>
+ 
+ <refsect1><title>options</title>
+   &apt-cmdblurb;
+
+   <variablelist>
+
+     &apt-commonoptions;
+     
+   </variablelist>
+ </refsect1>
+
+ <refsect1><title>Script usage</title>
+  <para>
+   The &apt; commandline is designed as a end-user tool and it may
+   change the output between versions. While it tries to not break
+   backward compatibility there is no guarantee for it either.
+   All features of &apt; are available in  &apt-cache; and &apt-get;
+   via APT options. Please prefer using these commands in your scripts.
+  </para>
+ </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>
+     <para>The option <literal>DPkgPM::Progress-Fancy</literal> is enabled.
+     </para>
+   </listitem>
+   <listitem>
+     <para>The option <literal>APT::Color</literal> is enabled.
+     </para>
+   </listitem>
+   <listitem>
+     <para>A new <literal>list</literal> command is available
+     similar to <literal>dpkg --list</literal>.
+     </para>
+   </listitem>
+   <listitem>
+     <para>The option <literal>upgrade</literal> has
+     <literal>--with-new-pkgs</literal> enabled by default.
+     </para>
+   </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>
diff --git a/doc/en/makefile b/doc/en/makefile
index 247ce38b5..d1415fea1 100644
--- a/doc/en/makefile
+++ b/doc/en/makefile
@@ -19,23 +19,23 @@ apt-vendor.ent: ../../vendor/current/apt-vendor.ent
 	ln -sf $(shell readlink -f $^) $@
 
 # Install generation hooks
-manpages: $($(LOCAL)-LIST) apt.8
+manpages: $($(LOCAL)-LIST) apt.7
 
 $($(LOCAL)-LIST) :: % : ../%.xml $(STYLESHEET) $(INCLUDES)
 	echo Creating man page $@
 	$(XSLTPROC) -o $@ $(STYLESHEET) $<
 
-apt.8: ../apt.8
-	cp -a ../apt.8 apt.8
+apt.7: ../apt.7
+	cp -a ../apt.7 apt.7
 
 # Clean rule
 .PHONY: clean/$(LOCAL)
 veryclean: clean/$(LOCAL)
 clean: clean/$(LOCAL)
 clean/$(LOCAL):
-	-rm -rf $($(@F)-LIST) apt.8 apt-vendor.ent
+	-rm -rf $($(@F)-LIST) apt.7 apt-vendor.ent
 endif
 
 # Chain to the manpage rule
-SOURCE = apt.8
+SOURCE = apt.7
 include $(MANPAGE_H)
diff --git a/doc/makefile b/doc/makefile
index 4b63e542f..e8d4c7ea5 100644
--- a/doc/makefile
+++ b/doc/makefile
@@ -66,9 +66,9 @@ update-po:
 
 manpages/subdirs: $(MANPAGEPOLIST)
 $(MANPAGEPOLIST) :: manpages-translation-% : %/makefile po4a.conf
-	# first line is for apt.8 (see Bug#696923)
+	# first line is for apt.7 (see Bug#696923)
 	po4a --previous --no-backups --translate-only $(dir $<)apt.ent \
-		$(patsubst %,--translate-only $(dir $<)%,$(patsubst %.8,%.$(subst /,,$(dir $<)).8,$(wildcard *.8))) \
+		$(patsubst %,--translate-only $(dir $<)%,$(patsubst %.7,%.$(subst /,,$(dir $<)).7,$(wildcard *.7))) \
 		$(patsubst %,--translate-only $(dir $<)%,$(patsubst %.1.xml,%.$(subst /,,$(dir $<)).1.xml,$(wildcard *.1.xml))) \
 		$(patsubst %,--translate-only $(dir $<)%,$(patsubst %.2.xml,%.$(subst /,,$(dir $<)).2.xml,$(wildcard *.2.xml))) \
 		$(patsubst %,--translate-only $(dir $<)%,$(patsubst %.3.xml,%.$(subst /,,$(dir $<)).3.xml,$(wildcard *.3.xml))) \
diff --git a/doc/po4a.conf b/doc/po4a.conf
index 14f19eddd..cf8999452 100644
--- a/doc/po4a.conf
+++ b/doc/po4a.conf
@@ -12,6 +12,7 @@
 
 # define source file and translated file (one file per line)
 [type: entity]  apt.ent $lang:$lang/apt.ent
+[type: manpage] apt.8.xml $lang:$lang/apt.$lang.8.xml add_$lang:xml.add
 [type: manpage] apt-get.8.xml $lang:$lang/apt-get.$lang.8.xml add_$lang:xml.add
 [type: manpage] apt-cache.8.xml $lang:$lang/apt-cache.$lang.8.xml add_$lang:xml.add
 [type: manpage] apt-key.8.xml $lang:$lang/apt-key.$lang.8.xml add_$lang:xml.add
@@ -25,7 +26,7 @@
 [type: manpage] apt-extracttemplates.1.xml $lang:$lang/apt-extracttemplates.$lang.1.xml add_$lang:xml.add
 [type: manpage] apt-sortpkgs.1.xml $lang:$lang/apt-sortpkgs.$lang.1.xml add_$lang:xml.add
 [type: manpage] apt-ftparchive.1.xml $lang:$lang/apt-ftparchive.$lang.1.xml add_$lang:xml.add
-[type: man]     apt.8 $lang:$lang/apt.$lang.8
+[type: man]     apt.7 $lang:$lang/apt.$lang.7
 
 [type: sgml]    guide.sgml $lang:$lang/guide.$lang.sgml
 #                 add_$lang::$lang/addendum/debiandoc_$lang.add