Skip to content

Commit

Permalink
doc: Add apt-patterns(7) manual page
Browse files Browse the repository at this point in the history
This does not describe much yet, as there's not much to talk
about.
  • Loading branch information
julian-klode committed Aug 15, 2019
1 parent 690ff4c commit 7e22425
Show file tree
Hide file tree
Showing 4 changed files with 90 additions and 0 deletions.
1 change: 1 addition & 0 deletions debian/apt.install
Original file line number Diff line number Diff line change
Expand Up @@ -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.*
Expand Down
1 change: 1 addition & 0 deletions doc/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
87 changes: 87 additions & 0 deletions doc/apt-patterns.7.xml
Original file line number Diff line number Diff line change
@@ -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 &mdash; the ones starting with ? &mdash; 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>
1 change: 1 addition & 0 deletions doc/po4a.conf
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 7e22425

Please sign in to comment.