summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/apt-mark.8.xml114
-rw-r--r--doc/apt.810
-rw-r--r--doc/makefile2
3 files changed, 121 insertions, 5 deletions
diff --git a/doc/apt-mark.8.xml b/doc/apt-mark.8.xml
new file mode 100644
index 000000000..5af27a337
--- /dev/null
+++ b/doc/apt-mark.8.xml
@@ -0,0 +1,114 @@
+<?xml version="1.0" encoding="utf-8" standalone="no"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+
+<!ENTITY % aptent SYSTEM "apt.ent">
+%aptent;
+
+]>
+
+<refentry>
+
+ <refentryinfo>
+ &apt-author.moconnor;
+ &apt-author.team;
+ &apt-email;
+ &apt-product;
+ <!-- The last update date -->
+ <date>2 November 2007</date>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>apt-mark</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <!-- Man page title -->
+ <refnamediv>
+ <refname>apt-mark</refname>
+ <refpurpose>Utility to sort package index files</refpurpose>
+ </refnamediv>
+
+ <!-- Arguments -->
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>apt-mark</command>
+ <arg><option>-hv</option></arg>
+ <arg><option>-f=<replaceable>FILENAME</replaceable></option></arg>
+ <group choice="req"><arg>markauto</arg><arg>unmarkauto</arg></group>
+ <arg choice="plain" rep="repeat"><replaceable>package</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>Description</title>
+ <para><command>apt-mark</command> will change whether a package has
+ been marked as being automatically installed.
+ </para>
+ <para>
+ When you request that a package is installed, and as a result
+ other packages are installed to satisfy its dependencies, the
+ depedencies are marked as being automatically installed. Once
+ these automatically installed packages are no longer depended on
+ by any manually installed packages, they will be removed.
+ </para>
+ <variablelist>
+ <varlistentry><term>markauto</term>
+ <listitem><para><literal>markauto</literal> is used to mark a
+ package as being automatically installed, which will cause the
+ package to be removed when no more manually installed packages
+ depend on this package.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term>unmarkauto</term>
+ <listitem><para><literal>unmarkauto</literal> is used to mark a
+ package as being manually installed, which will prevent the
+ package from being automatically removed if no other packages
+ depend on it.
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1><title>options</title>
+
+ <variablelist>
+ <varlistentry><term><option>-f=<filename>FILENAME</filename></option></term><term><option>--file=<filename>FILENAME</filename></option></term>
+ <listitem><para>
+
+ Read/Write package stats from <filename>FILENAME</filename>
+ instead of the default location, which
+ is <filename>extended_status</filename> in the directory defined
+ by the Configuration Item: <literal>Dir::State</literal>.</para></listitem>
+ </varlistentry>
+
+ <varlistentry><term><option>-h</option></term>
+ <term><option>--help</option></term>
+ <listitem><para>Show a short usage summary.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-v</option></term>
+ <term><option>--version</option></term>
+ <listitem><para>Show the program version.
+ </para>
+ </listitem>
+ </varlistentry>
+
+
+ </variablelist>
+ </refsect1>
+
+ <refsect1><title>See Also</title>
+ <para>&apt-conf;</para>
+ </refsect1>
+
+ <refsect1><title>Diagnostics</title>
+ <para><command>apt-mark</command> returns zero on normal operation, non-zero on error.</para>
+ </refsect1>
+
+ &manbugs;
+
+</refentry>
diff --git a/doc/apt.8 b/doc/apt.8
index 6f39c5387..2b5b9fb70 100644
--- a/doc/apt.8
+++ b/doc/apt.8
@@ -20,10 +20,12 @@ apt \- Advanced Package Tool
.SH SYNOPSIS
.B apt
.SH DESCRIPTION
-APT is a management system for software packages. It is still
-under development; the snazzy front ends are not yet available. In the
-meantime, please see
-.BR apt-get (8).
+APT is a management system for software packages. For normal day to day
+package management there are several frontends available, like
+.BR aptitude (8)
+for the command line or
+.BR synaptic (8)for X-Windows. Some options are only implemented in
+.BR apt-get (8) though.
.SH OPTIONS
None.
.SH FILES
diff --git a/doc/makefile b/doc/makefile
index 5f774b825..8a8a04c03 100644
--- a/doc/makefile
+++ b/doc/makefile
@@ -15,7 +15,7 @@ include $(DEBIANDOC_H)
SOURCE = apt-cache.8 apt-get.8 apt-cdrom.8 apt.conf.5 sources.list.5 \
apt-config.8 apt_preferences.5 \
apt-sortpkgs.1 apt-ftparchive.1 apt-extracttemplates.1 \
- apt-key.8 apt-secure.8
+ apt-key.8 apt-secure.8 apt-mark.8
INCLUDES = apt.ent
include $(XML_MANPAGE_H)