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