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