diff options
author | Julian Andres Klode <julian.klode@canonical.com> | 2019-08-15 11:19:20 +0200 |
---|---|---|
committer | Julian Andres Klode <julian.klode@canonical.com> | 2019-08-15 20:21:31 +0200 |
commit | 7e22425c2cf937fd45160c6bbbda9210ea5d52ba (patch) | |
tree | 18d5275194e432a96968357d54aeb545a715740a | |
parent | 690ff4c3e44e7063ebde2557b7c0087ab720b894 (diff) | |
download | apt-7e22425c2cf937fd45160c6bbbda9210ea5d52ba.tar.gz |
doc: Add apt-patterns(7) manual page
This does not describe much yet, as there's not much to talk
about.
-rw-r--r-- | debian/apt.install | 1 | ||||
-rw-r--r-- | doc/CMakeLists.txt | 1 | ||||
-rw-r--r-- | doc/apt-patterns.7.xml | 87 | ||||
-rw-r--r-- | doc/po4a.conf | 1 |
4 files changed, 90 insertions, 0 deletions
diff --git a/debian/apt.install b/debian/apt.install index f12eb240d..f745b3de5 100644 --- a/debian/apt.install +++ b/debian/apt.install @@ -37,6 +37,7 @@ usr/share/man/*/apt-get.* usr/share/man/*/apt-key.* usr/share/man/*/apt-mark.* usr/share/man/*/apt-secure.* +usr/share/man/*/apt-patterns.* usr/share/man/*/apt-transport-http.* usr/share/man/*/apt-transport-https.* usr/share/man/*/apt-transport-mirror.* diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 7cca4cf81..3060949e5 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -82,6 +82,7 @@ add_docbook(apt-man MANPAGE ALL apt-key.8.xml apt-mark.8.xml apt_preferences.5.xml + apt-patterns.7.xml apt-secure.8.xml apt-sortpkgs.1.xml apt-transport-http.1.xml diff --git a/doc/apt-patterns.7.xml b/doc/apt-patterns.7.xml new file mode 100644 index 000000000..079c493e4 --- /dev/null +++ b/doc/apt-patterns.7.xml @@ -0,0 +1,87 @@ +<?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>2019-08-15T00:00:00Z</date> + </refentryinfo> + + <refmeta> + <refentrytitle>apt-patterns</refentrytitle> + <manvolnum>7</manvolnum> + <refmiscinfo class="manual">APT</refmiscinfo> + </refmeta> + + <!-- Man page title --> + <refnamediv> + <refname>apt-patterns</refname> + <refpurpose>Syntax and semantics of apt search patterns</refpurpose> + </refnamediv> + + <refsect1><title>Description</title> + <para> + Starting with version 2.0, <command>APT</command> provides support for + patterns, which can be used to query the apt cache for packages. + </para> + </refsect1> + + <refsect1> + <title>Syntax</title> + <variablelist> + </variablelist> + + </refsect1> + + <refsect1><title>Examples</title> + </refsect1> + + <refsect1><title>Migrating from aptitude</title> + <para> + Patterns in apt are heavily inspired by patterns in aptitude, but with some tweaks: + </para> + <itemizedlist> + <listitem> + <para>Only long forms — the ones starting with ? — are supported</para> + </listitem> + <listitem> + <para> + Syntax is uniform: If there is an opening parenthesis after a term, it is always assumed to be the beginning of an argument list. + </para> + <para> + In aptitude, a syntactic form <code>"?foo(bar)"</code> could mean <code>"?and(?foo,bar)"</code> if foo does not take an argument. In APT, this will cause an error. + </para> + </listitem> + <listitem> + <para>Not all patterns are supported.</para> + </listitem> + <listitem> + <para>Some additional patterns are available, for example, for finding gstreamer codecs.</para> + </listitem> + <listitem> + <para>Escaping terms with <code>~</code> is not supported.</para> + </listitem> + <listitem> + <para>A trailing comma is allowed in argument lists</para> + </listitem> + </itemizedlist> + </refsect1> + + <refsect1><title>See Also</title> + <para> + &apt-get;, &apt; + </para> + </refsect1> + + &manbugs; + &manauthor; +</refentry> diff --git a/doc/po4a.conf b/doc/po4a.conf index 587215abc..1cf170b80 100644 --- a/doc/po4a.conf +++ b/doc/po4a.conf @@ -30,6 +30,7 @@ [type: manpage] apt-transport-http.1.xml $lang:$lang/apt-transport-http.$lang.1.xml add_$lang:xml.add [type: manpage] apt-transport-https.1.xml $lang:$lang/apt-transport-https.$lang.1.xml add_$lang:xml.add [type: manpage] apt-transport-mirror.1.xml $lang:$lang/apt-transport-mirror.$lang.1.xml add_$lang:xml.add +[type: manpage] apt-patterns.7.xml $lang:$lang/apt-patterns.7.xml add_$lang:xml.add [type: docbook] guide.dbk $lang:$lang/guide.$lang.dbk # add_$lang::$lang/addendum/docbook_$lang.add |