Merge my tree and the remote tree (no change, I guess)
[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 <!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
9 %aptverbatiment;
10
11 ]>
12
13 <refentry>
14
15 <refentryinfo>
16 &apt-author.moconnor;
17 &apt-author.team;
18 &apt-email;
19 &apt-product;
20 <!-- The last update date -->
21 <date>2011-04-21T00:00:00Z</date>
22 </refentryinfo>
23
24 <refmeta>
25 <refentrytitle>apt-mark</refentrytitle>
26 <manvolnum>8</manvolnum>
27 <refmiscinfo class="manual">APT</refmiscinfo>
28 </refmeta>
29
30 <!-- Man page title -->
31 <refnamediv>
32 <refname>apt-mark</refname>
33 <refpurpose>mark/unmark a package as being automatically-installed</refpurpose>
34 </refnamediv>
35
36 &synopsis-command-apt-mark;
37
38 <refsect1><title>Description</title>
39 <para><command>apt-mark</command> will change whether a package has
40 been marked as being automatically installed.
41 </para>
42 <para>
43 When you request that a package is installed, and as a result
44 other packages are installed to satisfy its dependencies, the
45 dependencies are marked as being automatically installed. Once
46 these automatically installed packages are no longer depended on
47 by any manually installed packages, they will be removed by e.g.
48 <command>apt-get</command> or <command>aptitude</command>.
49 </para>
50 <variablelist>
51 <varlistentry><term><option>auto</option></term>
52 <listitem><para><literal>auto</literal> is used to mark a
53 package as being automatically installed, which will cause the
54 package to be removed when no more manually installed packages
55 depend on this package.
56 </para></listitem>
57 </varlistentry>
58
59 <varlistentry><term><option>manual</option></term>
60 <listitem><para><literal>manual</literal> is used to mark a
61 package as being manually installed, which will prevent the
62 package from being automatically removed if no other packages
63 depend on it.
64 </para></listitem>
65 </varlistentry>
66
67 <varlistentry><term><option>hold</option></term>
68 <listitem><para><literal>hold</literal> is used to mark a
69 package as hold back, which will prevent the package from being
70 automatically installed, upgraded or removed.
71 The command is only a wrapper around <command>dpkg --set-selections</command>
72 and the state is therefore maintained by &dpkg; and not effected
73 by the <option>--filename</option> option.
74 </para></listitem>
75 </varlistentry>
76
77 <varlistentry><term><option>unhold</option></term>
78 <listitem><para><literal>unhold</literal> is used to cancel a
79 previously set hold on a package to allow all actions again.
80 </para></listitem>
81 </varlistentry>
82
83 <varlistentry><term><option>showauto</option></term>
84 <listitem><para><literal>showauto</literal> is used to print a
85 list of automatically installed packages with each package on a new line.
86 All automatically installed packages will be listed if no package is given.
87 If packages are given only those which are automatically installed will be shown.
88 </para></listitem>
89 </varlistentry>
90
91 <varlistentry><term><option>showmanual</option></term>
92 <listitem><para><literal>showmanual</literal> can be used in
93 the same way as <literal>showauto</literal> except that it will print
94 a list of manually installed packages instead.
95 </para></listitem>
96 </varlistentry>
97
98 <varlistentry><term><option>showhold</option></term>
99 <listitem><para><literal>showhold</literal> is used to print a list
100 of packages on hold in the same way as for the other show commands.
101 </para></listitem>
102 </varlistentry>
103
104
105 </variablelist>
106 </refsect1>
107
108 <refsect1><title>options</title>
109
110 <variablelist>
111 <varlistentry>
112 <term><option>-f=<filename><replaceable>&synopsis-filename;</replaceable></filename></option></term>
113 <term><option>--file=<filename><replaceable>&synopsis-filename;</replaceable></filename></option></term>
114 <listitem><para>
115 Read/Write package stats from the filename given with the parameter
116 <filename><replaceable>&synopsis-filename;</replaceable></filename>
117 instead of from the default location, which
118 is <filename>extended_status</filename> in the directory defined
119 by the Configuration Item: <literal>Dir::State</literal>.</para></listitem>
120 </varlistentry>
121
122 &apt-commonoptions;
123 </variablelist>
124 </refsect1>
125
126 <refsect1><title>Files</title>
127 <variablelist>
128 &file-extended_states;
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>