merged lp:~mvo/apt/apt-get-changelog
[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>9 August 2009</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 <!-- Arguments -->
37 <refsynopsisdiv>
38 <cmdsynopsis>
39 <command>apt-mark</command>
40 <arg><option>-hv</option></arg>
41 <arg><option>-f=<replaceable>FILENAME</replaceable></option></arg>
42 <group choice="plain">
43 <arg choice="plain">
44 <group choice="req">
45 <arg choice="plain">markauto</arg>
46 <arg choice="plain">unmarkauto</arg>
47 </group>
48 <arg choice="plain" rep="repeat"><replaceable>package</replaceable></arg>
49 </arg>
50 <arg choice="plain">showauto</arg>
51 </group>
52 </cmdsynopsis>
53 </refsynopsisdiv>
54
55 <refsect1><title>Description</title>
56 <para><command>apt-mark</command> will change whether a package has
57 been marked as being automatically installed.
58 </para>
59 <para>
60 When you request that a package is installed, and as a result
61 other packages are installed to satisfy its dependencies, the
62 dependencies are marked as being automatically installed. Once
63 these automatically installed packages are no longer depended on
64 by any manually installed packages, they will be removed by e.g.
65 <command>apt-get</command> or <command>aptitude</command>.
66 </para>
67 <variablelist>
68 <varlistentry><term>markauto</term>
69 <listitem><para><literal>markauto</literal> is used to mark a
70 package as being automatically installed, which will cause the
71 package to be removed when no more manually installed packages
72 depend on this package.
73 </para></listitem>
74 </varlistentry>
75
76 <varlistentry><term>unmarkauto</term>
77 <listitem><para><literal>unmarkauto</literal> is used to mark a
78 package as being manually installed, which will prevent the
79 package from being automatically removed if no other packages
80 depend on it.
81 </para></listitem>
82 </varlistentry>
83
84 <varlistentry><term>showauto</term>
85 <listitem><para><literal>showauto</literal> is used to print a
86 list of automatically installed packages with each package on a new line.
87 </para></listitem>
88 </varlistentry>
89 </variablelist>
90 </refsect1>
91
92 <refsect1><title>options</title>
93
94 <variablelist>
95 <varlistentry>
96 <term><option>-f=<filename><replaceable>FILENAME</replaceable></filename></option></term>
97 <term><option>--file=<filename><replaceable>FILENAME</replaceable></filename></option></term>
98 <listitem><para>
99
100 Read/Write package stats from <filename><replaceable>FILENAME</replaceable></filename>
101 instead of the default location, which
102 is <filename>extended_status</filename> in the directory defined
103 by the Configuration Item: <literal>Dir::State</literal>.</para></listitem>
104 </varlistentry>
105
106 <varlistentry><term><option>-h</option></term>
107 <term><option>--help</option></term>
108 <listitem><para>Show a short usage summary.
109 </para>
110 </listitem>
111 </varlistentry>
112
113 <varlistentry>
114 <term><option>-v</option></term>
115 <term><option>--version</option></term>
116 <listitem><para>Show the program version.
117 </para>
118 </listitem>
119 </varlistentry>
120
121
122 </variablelist>
123 </refsect1>
124
125 <refsect1><title>Files</title>
126 <variablelist>
127 &file-extended_states;
128 </variablelist>
129 </refsect1>
130
131 <refsect1><title>See Also</title>
132 <para>&apt-get;,&aptitude;,&apt-conf;</para>
133 </refsect1>
134
135 <refsect1><title>Diagnostics</title>
136 <para><command>apt-mark</command> returns zero on normal operation, non-zero on error.</para>
137 </refsect1>
138
139 &manbugs;
140
141 </refentry>