From: Joerg Jaspert Date: Fri, 30 Oct 2009 22:42:26 +0000 (+0100) Subject: remove manpages, not much sense to have them, noone uses them X-Git-Url: https://git.decadent.org.uk/gitweb/?a=commitdiff_plain;h=89ad368dc417a899e0cd321d97a77f5cbc4cef5b;p=dak.git remove manpages, not much sense to have them, noone uses them Signed-off-by: Joerg Jaspert --- diff --git a/docs/manpages/Makefile b/docs/manpages/Makefile deleted file mode 100644 index 75cf3cc0..00000000 --- a/docs/manpages/Makefile +++ /dev/null @@ -1,14 +0,0 @@ -#!/usr/bin/make -f - -SGMLMANPAGES = check-overrides.1.sgml clean-suites.1.sgml control-overrides.1.sgml control-suite.1.sgml import-users-from-passwd.1.sgml ls.1.sgml make-maintainers.1.sgml override.1.sgml poolize.1.sgml process-accepted.1.sgml process-new.1.sgml rm.1.sgml - -MANPAGES = $(patsubst %.sgml, dak_%, $(SGMLMANPAGES)) - - -all: $(MANPAGES) - -dak_%: %.sgml - docbook2man $< > /dev/null - -clean: - rm -f $(MANPAGES) manpage.links manpage.log manpage.refs diff --git a/docs/manpages/clean-suites.1.sgml b/docs/manpages/clean-suites.1.sgml deleted file mode 100644 index 621bbc34..00000000 --- a/docs/manpages/clean-suites.1.sgml +++ /dev/null @@ -1,82 +0,0 @@ - - -%dakent; - -]> - - - &dak-docinfo; - - - dak_clean-suites - 1 - - - - - dak clean-suites - Utility to clean out old packages - - - - - - dak clean-suites - - - - - Description</> - <para> - <command>dak clean-suites</command> is a utility to clean out old packages. It will clean out any binary packages not referenced by a suite and any source packages not referenced by a suite and not referenced by any binary packages. Cleaning is not actual deletion, but rather, removal of packages from the pool to a 'morgue' directory. The 'morgue' directory is split into dated sub-directories to keep things sane in big archives. - </PARA> - </REFSECT1> - - <RefSect1><Title>Options</> - - <variablelist> - <VarListEntry><term><option>-n/--no-action</option></> - <ListItem> - <Para>Don't actually clean any packages.</PARA> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-h/--help</option></> - <ListItem> - <Para>Show help and then exit.</PARA> - </LISTITEM> - </VarListEntry> - - </VariableList> - </RefSect1> - - <refsect1> - <title>Configuration - dak clean-suites uses dak's configuration file. It follows the typical ISC configuration format as seen in ISC tools like bind 8 and dhcpd. Apart from being able to alter the defaults for command line options, the following configuration items are used: - - - Clean-Suites::StayOfExecution - - This is the number of seconds unreferenced packages are left before being cleaned. - - - - Clean-Suites::MorgueSubDir - - If not blank, this is the subdirectory in the morgue used to hold removed packages. - - - - - - Diagnostics</> - <para> - <command>dak clean-suites</command> returns zero on normal operation, non-zero on error. - </PARA> - </RefSect1> - - &manauthor; - -</refentry> diff --git a/docs/manpages/control-overrides.1.sgml b/docs/manpages/control-overrides.1.sgml deleted file mode 100644 index 26440ad4..00000000 --- a/docs/manpages/control-overrides.1.sgml +++ /dev/null @@ -1,98 +0,0 @@ -<!-- -*- mode: sgml; mode: fold -*- --> -<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [ - -<!ENTITY % dakent SYSTEM "dak.ent"> -%dakent; - -]> - -<refentry> - &dak-docinfo; - - <refmeta> - <refentrytitle>dak_control-overrides</> - <manvolnum>1</> - </refmeta> - - <!-- Man page title --> - <refnamediv> - <refname>dak control-overrides</> - <refpurpose>Utility to manipulate the packages overrides</> - </refnamediv> - - <!-- Arguments --> - <refsynopsisdiv> - <cmdsynopsis> - <command>dak control-overrides</> - <arg><option><replaceable>options</replaceable></option></arg> - </cmdsynopsis> - </refsynopsisdiv> - - <RefSect1><Title>Description</> - <para> - <command>dak control-overrides</command> is the command line tool to handle override files. Override files can be listed or updated. - </para> - </refsect1> - <RefSect1><Title>Options</> - - <VariableList> - <varlistentry> - <term><option>-a/--add</option></term> - <listitem> - <para>Add entries to the override DB. Changes and deletions are ignored.</para> - </listitem> - </varlistentry> - - <VarListEntry><term><option>-c/--component=<replaceable>component</replaceable></option></> - <ListItem><Para>Uses the override DB for the component listed.</para> - </listitem> - </VarListEntry> - - <varlistentry> - <term><option>-h/--help</option></term> - <listitem> - <para>Display usage help and then exit.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>-l/--list</option></term> - <listitem> - <para>Lists the override DB to stdout.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>-q/--quiet</option></term> - <listitem> - <para>Be less verbose about what has been done.</para> - </listitem> - </varlistentry> - - <VarListEntry><term><option>-s/--suite=<replaceable>suite</replaceable></option></> - <ListItem><Para>Uses the override DB for the suite listed.</para></listitem> - </varlistentry> - - <VarListEntry><term><option>-S/--set</option></term> - <ListItem><Para>Set the override DB to the provided input.</PARA></LISTITEM> - </VarListEntry> - - <varlistentry> - <term><option>-t/--type=<replaceable>type</replaceable></option></term> - <listitem> - <para>Uses the override DB for the type listed. Possible values are: <literal>deb</literal>, <literal>udeb</literal> and <literal>dsc</literal>.</para> - </listitem> - </varlistentry> - - </VariableList> - </RefSect1> - - <RefSect1><Title>Diagnostics</> - <para> - <command>dak control-overrides</command> returns zero on normal operation, non-zero on error. - </para> - </RefSect1> - - &manauthor; - -</refentry> diff --git a/docs/manpages/control-suite.1.sgml b/docs/manpages/control-suite.1.sgml deleted file mode 100644 index 12c89c5a..00000000 --- a/docs/manpages/control-suite.1.sgml +++ /dev/null @@ -1,82 +0,0 @@ -<!-- -*- mode: sgml; mode: fold -*- --> -<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [ - -<!ENTITY % dakent SYSTEM "dak.ent"> -%dakent; - -]> - -<refentry> - &dak-docinfo; - - <refmeta> - <refentrytitle>dak_control-suite</> - <manvolnum>1</> - </refmeta> - - <!-- Man page title --> - <refnamediv> - <refname>dak control-suite</> - <refpurpose>Utility to alter or display the contents of a suite</> - </refnamediv> - - <!-- Arguments --> - <refsynopsisdiv> - <cmdsynopsis> - <command>dak control-suite</> - <arg><option><replaceable>options</replaceable></></arg> - <arg choice="plain"><replaceable>file...</replaceable></arg> - </cmdsynopsis> - </refsynopsisdiv> - - <RefSect1><Title>Description</> - <para> - <command>dak control-suite</command> is a utility to alter or display the contents of a suite. Input for alterations is taken either from filename(s) supplied or stdin. The format for both input and output is lines each with a whitespace separated list of: <literal>package</literal>, <literal>version</literal> and <literal>architecture</literal>. - </PARA> - </REFSECT1> - - <RefSect1><Title>Options</> - - <VariableList> - <VarListEntry><term><option>-a/--add=<replaceable>suite</replaceable></option></> - <ListItem> - <Para>Add to the suite.</PARA> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-l/--list=<replaceable>suite</replaceable></option></> - <ListItem> - <Para>List the contents of the suite.</PARA> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-r/--remove=<replaceable>suite</replaceable></option></> - <ListItem> - <Para>Remove from the suite.</PARA> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-s/--set=<replaceable>suite</replaceable></option></> - <ListItem> - <Para>Set the suite to exactly the input.</PARA> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-h/--help</option></> - <ListItem> - <Para>Show help and then exit.</PARA> - </LISTITEM> - </VarListEntry> - - </VariableList> - </RefSect1> - - <RefSect1><Title>Diagnostics</> - <para> - <command>dak control-suite</command> returns zero on normal operation, non-zero on error. - </PARA> - </RefSect1> - - &manauthor; - -</refentry> diff --git a/docs/manpages/dak.ent b/docs/manpages/dak.ent deleted file mode 100644 index 1860e8e5..00000000 --- a/docs/manpages/dak.ent +++ /dev/null @@ -1,20 +0,0 @@ -<!-- -*- mode: sgml; mode: fold -*- --> - -<!-- Boiler plate docinfo section --> -<!ENTITY dak-docinfo " - <docinfo> - <address><email>james@nocrew.org</email></address> - <author><firstname>James</firstname> <surname>Troup</surname></author> - <copyright><year>2000-2001</year> <holder>James Troup</holder></copyright> - <date>15 January 2001</date> - </docinfo> -"> - -<!-- Boiler plate Author section --> -<!ENTITY manauthor " - <RefSect1><Title>Author - - dak was written by James Troup james@nocrew.org. - - -"> diff --git a/docs/manpages/import-users-from-passwd.1.sgml b/docs/manpages/import-users-from-passwd.1.sgml deleted file mode 100644 index 0fd48511..00000000 --- a/docs/manpages/import-users-from-passwd.1.sgml +++ /dev/null @@ -1,94 +0,0 @@ - - -%dakent; - -]> - - - &dak-docinfo; - - - dak_import-users-from-passwd - 1 - - - - - dak import-users-from-passwd - Utility to sync PostgreSQL users with system users - - - - - - dak import-users-from-passwd - - - - - Description</> - <para> - <command>dak import-users-from-passwd</command> is a utility to sync PostgreSQL's user database with the system's users. It is designed to allow the use of 'peer sameuser' authentication. It simply adds any users in the password file into PostgreSQL's pg_user table if they are already not there. It will also warn you about users who are in the pg_user table but not in the password file. - </PARA> - </REFSECT1> - - <RefSect1><Title>Options</> - - <VariableList> - <VarListEntry><term><option>-n/--no-action<replaceable></replaceable></option></> - <ListItem> - <Para>Don't actually do anything.</PARA> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-q/--quiet<replaceable></replaceable></option></> - <ListItem> - <Para>Be quiet, i.e. display as little output as possible.</PARA> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-v/--verbose</option></> - <ListItem> - <Para>Be verbose, i.e. display more output than normal.</PARA> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-h/--help</option></> - <ListItem> - <Para>Show help and then exit.</PARA> - </LISTITEM> - </VarListEntry> - - </VariableList> - </RefSect1> - - <refsect1> - <title>Configuration - dak import-users-from-passwd uses dak's configuration file. It follows the typical ISC configuration format as seen in ISC tools like bind 8 and dhcpd. Apart from being able to alter the defaults for command line options, the following configuration items are used: - - - Import-Users-From-Passwd::ValidGID - - Each user's primary GID is compared with this, if it's not blank. If they match, the user will be processed, if they don't, the user will be skipped. - - - - Import-Users-From-Passwd::KnownPostgresUsers - - This is a comma-separated list of users who are in PostgreSQL's pg_user table but are not in the password file. - - - - - - Diagnostics</> - <para> - <command>dak import-users-from-passwd</command> returns zero on normal operation, non-zero on error. - </PARA> - </RefSect1> - - &manauthor; - -</refentry> diff --git a/docs/manpages/ls.1.sgml b/docs/manpages/ls.1.sgml deleted file mode 100644 index c7c4f29a..00000000 --- a/docs/manpages/ls.1.sgml +++ /dev/null @@ -1,104 +0,0 @@ -<!-- -*- mode: sgml; mode: fold -*- --> -<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [ - -<!ENTITY % dakent SYSTEM "dak.ent"> -%dakent; - -]> - -<refentry> - &dak-docinfo; - - <refmeta> - <refentrytitle>dak_ls</> - <manvolnum>1</> - </refmeta> - - <!-- Man page title --> - <refnamediv> - <refname>dak ls</> - <refpurpose>Utility to display information about packages</> - </refnamediv> - - <!-- Arguments --> - <refsynopsisdiv> - <cmdsynopsis> - <command>dak ls</> - <arg><option><replaceable>options</replaceable></></arg> - <arg choice="plain"><replaceable>package</replaceable></arg> - </cmdsynopsis> - </refsynopsisdiv> - - <RefSect1><Title>Description</> - <para> - <command>dak ls</command> is a utility to display information about packages, specificaly what suites they are in and for which architectures. - </PARA> - </REFSECT1> - - <RefSect1><Title>Options</> - - <VariableList> - <VarListEntry><term><option>-a/--architecture=<replaceable>architecture</replaceable></option></> - <ListItem> - <Para>Only list package information for the listed architecture(s).</PARA> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-b/--binary-type=<replaceable>binary type</replaceable></option></> - <ListItem> - <Para>Only show package information for the binary type ('deb' or 'udeb').</PARA> - </LISTITEM> - </VarListEntry> - - <varlistentry><term><option>-c/--component=<replaceable>component</replaceable></option></term> - <listitem> - <para>Only list package information for the listed component(s).</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>-g/--greaterorequal</option></term> - <term><option>-G/--greaterthan</option></term> - <listitem> - <para>Determine the highest version of each package in the target suite (which is forced to just unstable if one was not specificed) and, in addition to the normal output, also print a line suitable for sending in a reply to a buildd as a 'dep-wait' command. For <option>-g/--greaterorequal</option>, the versioned dependency is a >= one, e.g. <literallayout>dep-retry libgdbm-dev (>= 1.8.3-2)</literallayout></para> - <para>And for <option>-G/--greaterthan</option>, the versioned dependency is a >> one, e.g. <literallayout>dep-retry libflac-dev (>> 1.1.0-10)</literallayout></para> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>-r/--regex</option></term> - <listitem> - <para>Treat the <replaceable>package</replaceable> argument as a regex, rather than doing an exact search.</para> - </listitem> - </varlistentry> - - <VarListEntry><term><option>-s/--suite=<replaceable>suite</replaceable></option></> - <ListItem> - <Para>Only list package information for the suite(s) listed.</PARA> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-S/--source-and-binary</option></> - <ListItem> - <Para>For each package which is a source package, also show information about the binary packages it produces.</PARA> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-h/--help</option></> - <ListItem> - <Para>Show help and then exit.</PARA> - </LISTITEM> - </VarListEntry> - - </VariableList> - </RefSect1> - - <RefSect1><Title>Diagnostics</> - <para> - <command>dak ls</command> returns zero on normal operation, non-zero on error. - </PARA> - </RefSect1> - - &manauthor; - -</refentry> diff --git a/docs/manpages/make-maintainers.1.sgml b/docs/manpages/make-maintainers.1.sgml deleted file mode 100644 index 8cc324ce..00000000 --- a/docs/manpages/make-maintainers.1.sgml +++ /dev/null @@ -1,85 +0,0 @@ -<!-- -*- mode: sgml; mode: fold -*- --> -<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [ - -<!ENTITY % dakent SYSTEM "dak.ent"> -%dakent; - -]> - -<refentry> - &dak-docinfo; - - <refmeta> - <refentrytitle>dak_make-maintainers</> - <manvolnum>1</> - </refmeta> - - <!-- Man page title --> - <refnamediv> - <refname>dak make-maintainers</> - <refpurpose>Utility to generate an index of package's maintainers</> - </refnamediv> - - <!-- Arguments --> - <refsynopsisdiv> - <cmdsynopsis> - <command>dak make-maintainers</> - <arg><option><replaceable>options</replaceable></></arg> - <arg choice="plain"><replaceable>extra file...</replaceable></arg> - </cmdsynopsis> - </refsynopsisdiv> - - <RefSect1><Title>Description</> - <para> - <command>dak make-maintainers</command> is a utility to generate an index of package's maintainers. The output format is: -<literallayout>package~version maintainer</literallayout> - The input format of extra files can either be in this form or in the old style which is similar, but lacking the version number, i.e.: -<literallayout>package maintainer</literallayout> - dak Make-Maintainers will auto-detect the type of layout of the extra file. If the extra file is in the old style format the records in it are assumed to supersed any that were seen earlier (i.e. either from earlier extra files or generated from the SQL). - </Para> - <para> - dak Make-Maintainers determines the maintainer of a package by comparing suite priority (see 'Configuration') and then version number. - </PARA> - </REFSECT1> - - <RefSect1><Title>Options</> - - <variablelist> - <VarListEntry><term><option>-h/--help</option></> - <ListItem> - <Para>Show help and then exit.</PARA> - </LISTITEM> - </VarListEntry> - - </VariableList> - </RefSect1> - - <refsect1> - <title>Configuration - dak make-maintainers uses dak's configuration file. It follows the typical ISC configuration format as seen in ISC tools like bind 8 and dhcpd. Apart from being able to alter the defaults for command line options, the following configuration items are used: - - - Suite::<SUITE>::Priority - - Suite priority overrides the version checks dak make-maintainers does. A package in higher priority suite overrides versions in lower priority suites even if the version number in the higher priority suite is older. - - - - - - - New versus Old output format - Converting the new output format to the old output format is easy with some simple sed + awk, e.g. -sed -e "s/~[^ ]*\([ ]\)/\1/" | awk '{printf "%-20s ", $1; for (i=2; i<=NF; i++) printf "%s ", $i; printf "\n";}' - - - - Diagnostics</> - <para> - <command>dak make-maintainers</command> returns zero on normal operation, non-zero on error. - </PARA> - </RefSect1> - - &manauthor; - -</refentry> diff --git a/docs/manpages/override.1.sgml b/docs/manpages/override.1.sgml deleted file mode 100644 index 12afac55..00000000 --- a/docs/manpages/override.1.sgml +++ /dev/null @@ -1,87 +0,0 @@ -<!-- -*- mode: sgml -*- --> -<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [ - -<!ENTITY % dakent SYSTEM "dak.ent"> -%dakent; - -]> - -<refentry> - &dak-docinfo; - - <refmeta> - <refentrytitle>dak_override</> - <manvolnum>1</> - </refmeta> - - <!-- Man page title --> - <refnamediv> - <refname>dak override</> - <refpurpose>Make micromodifications or queries to the overrides table</> - </refnamediv> - - <!-- Arguments --> - <refsynopsisdiv> - <cmdsynopsis> - <command>dak override</> - <arg><option><replaceable>options</replaceable></></arg> - <arg choice="plain"><replaceable>package</replaceable></arg> - <arg><option><replaceable>section</replaceable></></arg> - <arg><option><replaceable>priority</replaceable></></arg> - </cmdsynopsis> - </refsynopsisdiv> - - <RefSect1><Title>Description</> - <para> - <command>dak override</command> makes micromodifications and queries the overrides. - </PARA> - </REFSECT1> - - <RefSect1><Title>Options</> - - <VariableList> - <VarListEntry><term><option>-h/--help</option></> - <ListItem> - <Para>Show help and then exit.</PARA> - </LISTITEM> - </VarListEntry> - <VarListEntry><term><option>-d/--done=<replaceable>BUG#</replaceable></option></> - <ListItem> - <Para>Close the listed bugs as part of adjusting the overrides</PARA> - </LISTITEM> - </VarListEntry> - <VarListEntry><term><option>-n/--no-action</option></> - <ListItem> - <Para>Show what dak override would do but make no changes</PARA> - </LISTITEM> - </VarListEntry> - <VarListEntry><term><option>-s/--suite=<replaceable>suite</replaceable></option></> - <ListItem> - <Para>Affect the overrides in suite listed. The default is <literal>unstable</literal></PARA> - </LISTITEM> - </VarListEntry> - - </VariableList> - </RefSect1> - - <RefSect1><Title>Common use</> - <para> - <command>dak override</command> when invoked with only a package name will tell you what section and priority the given package has. - </PARA> - <para> - <command>dak override</command> when invoked with a package and one or two other values will set the section and/or priority to the values given. You may use a single period ('.') to represent "do not change" or you can ommit the value you do not want to change. - </PARA> - </RefSect1> - <RefSect1><Title>Notes</> - - <Para><command>dak override</command> essentially lets you do what <command>dak control-overrides</command> does only on the microscopic scale rather than the macroscopic scale of <command>dak control-overrides</command>. Use with care.</> - - <RefSect1><Title>Diagnostics</> - <para> - <command>dak override</command> returns zero on normal operation, non-zero on error. - </PARA> - </RefSect1> - - &manauthor; - -</refentry> diff --git a/docs/manpages/process-accepted.1.sgml b/docs/manpages/process-accepted.1.sgml deleted file mode 100644 index 1f3cf4e6..00000000 --- a/docs/manpages/process-accepted.1.sgml +++ /dev/null @@ -1,100 +0,0 @@ -<!-- -*- mode: sgml; mode: fold -*- --> -<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [ - -<!ENTITY % dakent SYSTEM "dak.ent"> -%dakent; - -]> - -<refentry> - &dak-docinfo; - - <refmeta> - <refentrytitle>dak_process-accepted</> - <manvolnum>1</> - </refmeta> - - <!-- Man page title --> - <refnamediv> - <refname>dak process-accepted</> - <refpurpose>Installs packages from accepted</> - </refnamediv> - - <!-- Arguments --> - <refsynopsisdiv> - <cmdsynopsis> - <command>dak process-accepted</> - <arg><option><replaceable>options</replaceable></></arg> - <arg choice="plain"><replaceable>changes_file</replaceable></arg> - <arg><option><replaceable>...</replaceable></option></arg> - </cmdsynopsis> - </refsynopsisdiv> - - <RefSect1><Title>Description</> - <para> - <command>dak process-accepted</command> is the program which installs packages from the accepted directory into the distribution. - </PARA></REFSECT1> - - <RefSect1><Title>Options</> - - <VariableList> - - <varlistentry> - <term><option>-a/--automatic</option></term> - <listitem> - <para>Run automatically; i.e. perform the default action if it's possible to do so without user interaction. Intend for use in cron jobs and the like.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>-h/--help</option></term> - <listitem> - <para>Display usage help and then exit.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>-m/--manual-reject=<replaceable>message</replaceable></option></term> - <listitem> - <para>Perform a manual rejection of the package. The <replaceable>message</replaceable> is included in the rejection notice sent to the uploader. If no <replaceable>message</replaceable> is given, an editor will be spawned so one can be added to the rejection notice. - </listitem> - </varlistentry> - - <varlistentry> - <term><option>-n/--no-action</option></term> - <listitem> - <para>Don't actually install anything; just show what would be done.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>-p/--no-lock</option></term> - <listitem> - <para>Don't check the lockfile. Obviously dangerous and should only be used for cron jobs (if at all).</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>-v/--version</option></term> - <listitem> - <para>Display the version number and then exit.</para> - </listitem> - </varlistentry> - - </VariableList> - </RefSect1> - - <RefSect1><Title>Diagnostics</> - <para> - <command>dak process-accepted</command> returns zero on normal operation, non-zero on error. - </PARA> - </RefSect1> - - <refsect1> - <title>Acknowledgements - dak process-accepted is based very heavily on dinstall, written by Guy Maor maor@debian.org; in fact it started out life as a dinstall clone. - - - &manauthor; - - diff --git a/docs/manpages/process-new.1.sgml b/docs/manpages/process-new.1.sgml deleted file mode 100644 index f99c6cfc..00000000 --- a/docs/manpages/process-new.1.sgml +++ /dev/null @@ -1,95 +0,0 @@ - - -%dakent; - -]> - - - &dak-docinfo; - - - dak_process-new - 1 - - - - - dak process-new - Processes BYHAND and NEW packages - - - - - - dak process-new - - changes_file - - - - - Description</> - <para> - <command>dak process-new</command> is the program which installs packages from the accepted directory into the distribution. - </PARA></REFSECT1> - - <RefSect1><Title>Options</> - - <VariableList> - - <varlistentry> - <term><option>-a/--automatic</option></term> - <listitem> - <para>Run automatically; i.e. perform the default action if it's possible to do so without user interaction. Intend for use in cron jobs and the like.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>-h/--help</option></term> - <listitem> - <para>Display usage help and then exit.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>-m/--manual-reject=<replaceable>message</replaceable></option></term> - <listitem> - <para>Perform a manual rejection of the package. The <replaceable>message</replaceable> is included in the rejection notice sent to the uploader. If no <replaceable>message</replaceable> is given, an editor will be spawned so one can be added to the rejection notice. - </listitem> - </varlistentry> - - <varlistentry> - <term><option>-n/--no-action</option></term> - <listitem> - <para>Don't actually install anything; just show what would be done.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>-p/--no-lock</option></term> - <listitem> - <para>Don't check the lockfile. Obviously dangerous and should only be used for cron jobs (if at all).</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>-v/--version</option></term> - <listitem> - <para>Display the version number and then exit.</para> - </listitem> - </varlistentry> - - </VariableList> - </RefSect1> - - <RefSect1><Title>Diagnostics</> - <para> - <command>dak process-new</command> returns zero on normal operation, non-zero on error. - </PARA> - </RefSect1> - - &manauthor; - -</refentry> diff --git a/docs/manpages/rm.1.sgml b/docs/manpages/rm.1.sgml deleted file mode 100644 index 5b2eaf93..00000000 --- a/docs/manpages/rm.1.sgml +++ /dev/null @@ -1,215 +0,0 @@ -<!-- -*- mode: sgml; mode: fold -*- --> -<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [ - -<!ENTITY % dakent SYSTEM "dak.ent"> -%dakent; - -]> - -<refentry> - &dak-docinfo; - - <refmeta> - <refentrytitle>dak_rm</> - <manvolnum>1</> - </refmeta> - - <!-- Man page title --> - <refnamediv> - <refname>dak rm</> - <refpurpose>Utility to remove/add packages from suites</> - </refnamediv> - - <!-- Arguments --> - <refsynopsisdiv> - <cmdsynopsis> - <command>dak rm</> - <arg><option><replaceable>options</replaceable></></arg> - <arg choice="plain"><replaceable>package</replaceable></arg> - <arg><option><replaceable>...</replaceable></option></arg> - </cmdsynopsis> - </refsynopsisdiv> - - <RefSect1><Title>Description</> - <para> - <command>dak rm</command> is the command line tool to add and remove package sets from suites with enforced logging, optional bug closing and override updates. - </PARA> - </REFSECT1> - - <RefSect1><Title>Options</> - - <VariableList> - <VarListEntry><term><option>-a/--architecture=<replaceable>architecture</replaceable></option></> - <ListItem> - <Para>Restrict the packages being considered to the architecture(s) listed.</PARA> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-b/--binary</option></> - <ListItem> - <Para>Only look at binary packages.</PARA> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-c/--component=<replaceable>component</replaceable></option></> - <ListItem> - <Para>Restrict the packages being considered to those found in the component(s) listed. The default is <literal>main</literal>.</PARA> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-C/--carbon-copy=<replaceable>[ bug number | 'package' | email address ]</replaceable></option></> - <ListItem> - <Para>Carbon copy the bug closing mail to the address(es) given. If the removal was not requested by the maintainer, this option should always be used to inform the maintainer of the package's removal. 3 types of address are accepted.</PARA> - <itemizedlist> - <listitem> - <para>number - assumed to be a bug number, and expanded to nnnnn@bugs.debian.org.</para> - </listitem> - <listitem> - <para>'<literal>package</literal>' - carbon copy package@package.debian.org for each package given as an argument.</para> - </listitem> - <listitem> - <para>anything containing '@' - assumed to be an email address, and carbon copied as is.</para> - </listitem> - </itemizedlist> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-d/--done=<replaceable>done</replaceable></option></> - <ListItem> - <Para>Close the bug(s) listed on successful completion.</PARA> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-m/--reason=<replaceable>reason</replaceable></option></> - <ListItem> - <Para>The reason for the removal or addition of the package(s). This is a required option; if not provided an editor will be spawned so the reason can be added there.</PARA> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-n/--no-action</option></> - <ListItem> - <Para>Don't actually do anything; just show what would be done.</PARA> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-p/--partial</option></> - <ListItem> - <Para>Partial removal of a package, so the package is not removed from the overrides. This option is implied by <option>-a/--architecture</option>.</PARA> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-R/--rdep-check</option></> - <ListItem> - <Para>Check the reverse dependencies (and build-dependencies) of the packages that are to be removed and warn if anything will break.</PARA> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-s/--suite=<replaceable>suite</replaceable></option></> - <ListItem> - <Para>Only add/remove the packages from the suite(s) listed. The default is <literal>unstable</literal></PARA> - </LISTITEM> - </VarListEntry> - - <VarListEntry><term><option>-S/--source-only</option></> - <ListItem> - <Para>Only look at source packages.</PARA> - </LISTITEM> - </VarListEntry> - - </VariableList> - </RefSect1> - - <refsect1> - <title>How packages are chosen - There are 3 methods for selecting packages. - - - Source + Binaries. (default) - In this mode dak rm will assume each of the package(s) passed as arguments are source packages and will also remove any binary packages built from these source packages. - - - Binary only. - Only binary packages are searched; source packages are ignored. This mode is chosen by use of the switch. - This should only be used for orphaned binary packages (i.e. those no longer built by source packages); otherwise, in any system (e.g. Debian) which has auto-building, pointless (and uninstallable) recompiles will be triggered. - - - Source only. - Only source packages are searched; binary packages are ignored. This mode is chosen by use of the switch. - - - - - - Configuration - dak rm uses dak's configuration file. It follows the typical ISC configuration format as seen in ISC tools like bind 8 and dhcpd. Apart from being able to alter the defaults for command line options, the following configuration items are used: - - - Rm::MyEmailAddress - - This is used as the From: line for bug closing mails as per the -d/--done command line switch. It, obviously, must be a RFC-822 valid email address. - - - - Rm::LogFile - - This is the (absolute) file name of the logfile that dak rm unconditionally writes too. This can not be empty or an invalid file. - - - - - - - Examples - The first example is of a source+binaries package removal. - - -$ dak rm -d 68136 -m "Requested by tbm@; confirmed with maintainer. Superseded by libgmp2" gmp1 -Working... done. -Will remove the following packages from unstable: - - gmp1 | 1.3.2-8.2 | source, alpha, hppa, arm, i386, m68k, powerpc, sparc - gmp1-dev | 1.3.2-8.2 | alpha, hppa, arm, i386, m68k, powerpc, sparc - - -------------------- Reason ------------------- -Requested by tbm@; confirmed with maintainer. Superseded by libgmp2 ----------------------------------------------- - -Continue (y/N)? y - Deleting... done. -$ - - - The second example is of a binary-only multi-package removal. - - -$ dak rm -d 82562 -m "Requested by paul@; NBS." -b libgtkextra{5,9,10} -Working... done. -Will remove the following packages from unstable: - -libgtkextra10 | 0.99.10-2 | alpha, i386, m68k, powerpc, sparc -libgtkextra5 | 0.99.5-1 | alpha, i386, m68k, powerpc, sparc -libgtkextra9 | 0.99.9-1 | alpha, i386, m68k, powerpc, sparc - -Will also close bugs: 82562 - -------------------- Reason ------------------- -Requested by paul@; NBS. ----------------------------------------------- - -Continue (y/N)? y - Deleting... done. -$ - - - - - Diagnostics</> - <para> - <command>dak rm</command> returns zero on normal operation, non-zero on error. - </PARA> - </RefSect1> - - &manauthor; - -</refentry>