]> git.saurik.com Git - apt.git/commitdiff
start adding apt.8.xml
authorMichael Vogt <mvo@debian.org>
Mon, 25 Nov 2013 07:16:37 +0000 (08:16 +0100)
committerMichael Vogt <mvo@debian.org>
Mon, 25 Nov 2013 07:16:37 +0000 (08:16 +0100)
cmdline/apt.cc
doc/apt-verbatim.ent
doc/apt.7 [new file with mode: 0644]
doc/apt.8 [deleted file]
doc/apt.8.xml [new file with mode: 0644]
doc/makefile
doc/po4a.conf

index e30967ec216be1770d07f4ec74c998d28824bbce..b2f19c0496b481155ac2760a6afc6d37a5636910 100644 (file)
@@ -120,7 +120,7 @@ int main(int argc, const char *argv[])                                      /*{{{*/
     }
 
    // FIXME: move into a new libprivate/private-install.cc:Install()
-   _config->Set("DPkgPM::Progress", "1");
+   _config->Set("DPkgPM::Progress-Fancy", "1");
    _config->Set("Apt::Color", "1");
 
    // Parse the command line and initialize the package library
index 0d0d95c7afb905c636dd9e636b4dc4a48cdcf2b0..8581ec630b3dd9329f3007ff1e740beb8ce4e4c8 100644 (file)
 <!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.7 b/doc/apt.7
new file mode 100644 (file)
index 0000000..5cdfa78
--- /dev/null
+++ b/doc/apt.7
@@ -0,0 +1,55 @@
+.\" This manpage is copyright (C) 1998 Branden Robinson <branden@debian.org>.
+.\" 
+.\" This is free software; you may redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as
+.\" published by the Free Software Foundation; either version 2,
+.\" or (at your option) any later version.
+.\"
+.\" This is distributed in the hope that it will be useful, but
+.\" WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public
+.\" 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 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
+package management there are several frontends available, such as
+.BR aptitude (8)
+for the command line or
+.BR synaptic (8)
+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),
+.BR sources.list (5),
+.BR apt_preferences (5),
+.BR apt-secure (8)
+.SH DIAGNOSTICS
+apt returns zero on normal operation, decimal 100 on error.
+.SH BUGS
+This manpage isn't even started.
+.PP
+See <http://bugs.debian.org/apt>.  If you wish to report a
+bug in
+.BR apt ,
+please see
+.I /usr/share/doc/debian/bug-reporting.txt
+or the
+.BR reportbug (1)
+command.
+.SH AUTHOR
+apt was written by the APT team <apt@packages.debian.org>.
diff --git a/doc/apt.8 b/doc/apt.8
deleted file mode 100644 (file)
index d84a3b4..0000000
--- a/doc/apt.8
+++ /dev/null
@@ -1,52 +0,0 @@
-.\" This manpage is copyright (C) 1998 Branden Robinson <branden@debian.org>.
-.\" 
-.\" This is free software; you may redistribute it and/or modify
-.\" it under the terms of the GNU General Public License as
-.\" published by the Free Software Foundation; either version 2,
-.\" or (at your option) any later version.
-.\"
-.\" This is distributed in the hope that it will be useful, but
-.\" WITHOUT ANY WARRANTY; without even the implied warranty of
-.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-.\" GNU General Public License for more details.
-.\"
-.\" You should have received a copy of the GNU General Public
-.\" 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"
-.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
-package management there are several frontends available, such as
-.BR aptitude (8)
-for the command line or
-.BR synaptic (8)
-for the X Window System. Some options are only implemented in
-.BR apt-get (8)
-though.
-.SH SEE ALSO
-.BR apt-cache (8),
-.BR apt-get (8),
-.BR apt.conf (5),
-.BR sources.list (5),
-.BR apt_preferences (5),
-.BR apt-secure (8)
-.SH DIAGNOSTICS
-apt returns zero on normal operation, decimal 100 on error.
-.SH BUGS
-This manpage isn't even started.
-.PP
-See <http://bugs.debian.org/apt>.  If you wish to report a
-bug in
-.BR apt ,
-please see
-.I /usr/share/doc/debian/bug-reporting.txt
-or the
-.BR reportbug (1)
-command.
-.SH AUTHOR
-apt was written by the APT team <apt@packages.debian.org>.
diff --git a/doc/apt.8.xml b/doc/apt.8.xml
new file mode 100644 (file)
index 0000000..0340e04
--- /dev/null
@@ -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>
index 274fbc2783d8c8b20298bd81cbe4c08bb049f946..fdbf53e9f405bdc31b3ffd46f4d9692215d760d4 100644 (file)
@@ -59,9 +59,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))) \
index 14f19edddaa4daef1964c82705c560ab50c4f938..cf8999452fa1b2a3373051358270a4b2cc9cb360 100644 (file)
@@ -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