[doc/apt-mark.8.xml] improve manpage based on patch by Carl Chenet, thanks!
[ntk/apt.git] / doc / apt-mark.8.xml
1 <?xml version="1.0" encoding="utf-8" standalone="no"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4
5 <!ENTITY % aptent SYSTEM "apt.ent">
6 %aptent;
7
8 ]>
9
10 <refentry>
11
12 <refentryinfo>
13 &apt-author.moconnor;
14 &apt-author.team;
15 &apt-email;
16 &apt-product;
17 <!-- The last update date -->
18 <date>9 August 2009</date>
19 </refentryinfo>
20
21 <refmeta>
22 <refentrytitle>apt-mark</refentrytitle>
23 <manvolnum>8</manvolnum>
24 </refmeta>
25
26 <!-- Man page title -->
27 <refnamediv>
28 <refname>apt-mark</refname>
29 <refpurpose>mark/unmark a package as being automatically-installed</refpurpose>
30 </refnamediv>
31
32 <!-- Arguments -->
33 <refsynopsisdiv>
34 <cmdsynopsis>
35 <command>apt-mark</command>
36 <arg><option>-hv</option></arg>
37 <arg><option>-f=<replaceable>FILENAME</replaceable></option></arg>
38 <group choice="plain">
39 <arg choice="plain">
40 <group choice="req">
41 <arg choice="plain">markauto</arg>
42 <arg choice="plain">unmarkauto</arg>
43 </group>
44 <arg choice="plain" rep="repeat"><replaceable>package</replaceable></arg>
45 </arg>
46 <arg choice="plain">showauto</arg>
47 </group>
48 </cmdsynopsis>
49 </refsynopsisdiv>
50
51 <refsect1><title>Description</title>
52 <para><command>apt-mark</command> will change whether a package has
53 been marked as being automatically installed.
54 </para>
55 <para>
56 When you request that a package is installed, and as a result
57 other packages are installed to satisfy its dependencies, the
58 dependencies are marked as being automatically installed. Once
59 these automatically installed packages are no longer depended on
60 by any manually installed packages, they will be removed by e.g.
61 <command>apt-get</command> or <command>aptitude</command>.
62 </para>
63 <variablelist>
64 <varlistentry><term>markauto</term>
65 <listitem><para><literal>markauto</literal> is used to mark a
66 package as being automatically installed, which will cause the
67 package to be removed when no more manually installed packages
68 depend on this package.
69 </para></listitem>
70 </varlistentry>
71
72 <varlistentry><term>unmarkauto</term>
73 <listitem><para><literal>unmarkauto</literal> is used to mark a
74 package as being manually installed, which will prevent the
75 package from being automatically removed if no other packages
76 depend on it.
77 </para></listitem>
78 </varlistentry>
79
80 <varlistentry><term>showauto</term>
81 <listitem><para><literal>showauto</literal> is used to print a
82 list of manually installed packages with each package on a new line.
83 </para></listitem>
84 </varlistentry>
85 </variablelist>
86 </refsect1>
87
88 <refsect1><title>options</title>
89
90 <variablelist>
91 <varlistentry>
92 <term><option>-f=<filename><replaceable>FILENAME</replaceable></filename></option></term>
93 <term><option>--file=<filename><replaceable>FILENAME</replaceable></filename></option></term>
94 <listitem><para>
95
96 Read/Write package stats from <filename><replaceable>FILENAME</replaceable></filename>
97 instead of the default location, which
98 is <filename>extended_status</filename> in the directory defined
99 by the Configuration Item: <literal>Dir::State</literal>.</para></listitem>
100 </varlistentry>
101
102 <varlistentry><term><option>-h</option></term>
103 <term><option>--help</option></term>
104 <listitem><para>Show a short usage summary.
105 </para>
106 </listitem>
107 </varlistentry>
108
109 <varlistentry>
110 <term><option>-v</option></term>
111 <term><option>--version</option></term>
112 <listitem><para>Show the program version.
113 </para>
114 </listitem>
115 </varlistentry>
116
117
118 </variablelist>
119 </refsect1>
120
121 <refsect1><title>Files</title>
122 <variablelist>
123 <varlistentry><term><filename>/var/lib/apt/extended_states</filename></term>
124 <listitem><para>Status list of auto-installed packages.
125 Configuration Item: <literal>Dir::State</literal>
126 sets the path to the <filename>extended_states</filename> file.
127 </para></listitem>
128 </varlistentry>
129 </variablelist>
130 </refsect1>
131
132 <refsect1><title>See Also</title>
133 <para>&apt-get;,&aptitude;,&apt-conf;</para>
134 </refsect1>
135
136 <refsect1><title>Diagnostics</title>
137 <para><command>apt-mark</command> returns zero on normal operation, non-zero on error.</para>
138 </refsect1>
139
140 &manbugs;
141
142 </refentry>