docs/manpages/ls.1.sgml

   1 <!-- -*- mode: sgml; mode: fold -*- -->
   2 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
   3
   4 <!ENTITY % dakent SYSTEM "dak.ent">
   5 %dakent;
   6
   7 ]>
   8
   9 <refentry>
  10   &dak-docinfo;
  11
  12   <refmeta>
  13     <refentrytitle>dak_ls</>
  14     <manvolnum>1</>
  15   </refmeta>
  16
  17   <!-- Man page title -->
  18   <refnamediv>
  19     <refname>dak ls</>
  20     <refpurpose>Utility to display information about packages</>
  21   </refnamediv>
  22
  23   <!-- Arguments -->
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>dak ls</>
  27       <arg><option><replaceable>options</replaceable></></arg>
  28       <arg choice="plain"><replaceable>package</replaceable></arg>
  29     </cmdsynopsis>
  30   </refsynopsisdiv>
  31
  32   <RefSect1><Title>Description</>
  33     <para>
  34       <command>dak ls</command> is a utility to display information about packages, specificaly what suites they are in and for which architectures.
  35     </PARA>
  36   </REFSECT1>
  37
  38   <RefSect1><Title>Options</>
  39
  40     <VariableList>
  41       <VarListEntry><term><option>-a/--architecture=<replaceable>architecture</replaceable></option></>
  42         <ListItem>
  43           <Para>Only list package information for the listed architecture(s).</PARA>
  44         </LISTITEM>
  45       </VarListEntry>
  46
  47       <VarListEntry><term><option>-b/--binary-type=<replaceable>binary type</replaceable></option></>
  48         <ListItem>
  49           <Para>Only show package information for the binary type ('deb' or 'udeb').</PARA>
  50         </LISTITEM>
  51       </VarListEntry>
  52
  53       <varlistentry><term><option>-c/--component=<replaceable>component</replaceable></option></term>
  54         <listitem>
  55           <para>Only list package information for the listed component(s).</para>
  56         </listitem>
  57       </varlistentry>
  58
  59       <varlistentry>
  60         <term><option>-g/--greaterorequal</option></term>
  61         <term><option>-G/--greaterthan</option></term>
  62         <listitem>
  63           <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>
  64           <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>
  65         </listitem>
  66       </varlistentry>
  67
  68       <varlistentry>
  69         <term><option>-r/--regex</option></term>
  70         <listitem>
  71           <para>Treat the <replaceable>package</replaceable> argument as a regex, rather than doing an exact search.</para>
  72         </listitem>
  73       </varlistentry>
  74
  75       <VarListEntry><term><option>-s/--suite=<replaceable>suite</replaceable></option></>
  76         <ListItem>
  77           <Para>Only list package information for the suite(s) listed.</PARA>
  78         </LISTITEM>
  79       </VarListEntry>
  80
  81       <VarListEntry><term><option>-S/--source-and-binary</option></>
  82         <ListItem>
  83           <Para>For each package which is a source package, also show information about the binary packages it produces.</PARA>
  84         </LISTITEM>
  85       </VarListEntry>
  86
  87       <VarListEntry><term><option>-h/--help</option></>
  88         <ListItem>
  89           <Para>Show help and then exit.</PARA>
  90         </LISTITEM>
  91       </VarListEntry>
  92
  93     </VariableList>
  94   </RefSect1>
  95
  96   <RefSect1><Title>Diagnostics</>
  97     <para>
  98       <command>dak ls</command> returns zero on normal operation, non-zero on error.
  99     </PARA>
 100   </RefSect1>
 101
 102   &manauthor;
 103
 104 </refentry>