summaryrefslogtreecommitdiff
path: root/doc/apt-sortpkgs.1.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/apt-sortpkgs.1.xml')
-rw-r--r--doc/apt-sortpkgs.1.xml69
1 files changed, 69 insertions, 0 deletions
diff --git a/doc/apt-sortpkgs.1.xml b/doc/apt-sortpkgs.1.xml
new file mode 100644
index 000000000..b7f199306
--- /dev/null
+++ b/doc/apt-sortpkgs.1.xml
@@ -0,0 +1,69 @@
+<?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;
+<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
+]>
+
+<refentry>
+
+ <refentryinfo>
+ &apt-author.jgunthorpe;
+ &apt-author.team;
+ &apt-email;
+ &apt-product;
+ <!-- The last update date -->
+ <date>2013-11-30T00:00:00Z</date>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>apt-sortpkgs</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">APT</refmiscinfo>
+ </refmeta>
+
+ <!-- Man page title -->
+ <refnamediv>
+ <refname>apt-sortpkgs</refname>
+ <refpurpose>Utility to sort package index files</refpurpose>
+ </refnamediv>
+
+ &synopsis-command-apt-sortpkgs;
+
+ <refsect1><title>Description</title>
+ <para><command>apt-sortpkgs</command> will take an index file (source index or package
+ index) and sort the records so that they are ordered by the package name.
+ It will also sort the internal fields of each record according to the
+ internal sorting rules.</para>
+
+ <para>
+ All output is sent to standard output; the input must be a seekable file.</para>
+ </refsect1>
+
+ <refsect1><title>options</title>
+ &apt-cmdblurb;
+
+ <variablelist>
+ <varlistentry><term><option>-s</option></term><term><option>--source</option></term>
+ <listitem><para>
+ Use source index field ordering.
+ Configuration Item: <literal>APT::SortPkgs::Source</literal>.</para></listitem>
+ </varlistentry>
+
+ &apt-commonoptions;
+
+ </variablelist>
+ </refsect1>
+
+ <refsect1><title>See Also</title>
+ <para>&apt-conf;</para>
+ </refsect1>
+
+ <refsect1><title>Diagnostics</title>
+ <para><command>apt-sortpkgs</command> returns zero on normal operation, decimal 100 on error.</para>
+ </refsect1>
+
+ &manbugs;
+
+</refentry>