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