]> git.decadent.org.uk Git - dak.git/blob - docs/catherine.1.sgml
sync
[dak.git] / docs / catherine.1.sgml
1 <!-- -*- mode: sgml; mode: fold -*- -->
2 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
3
4 <!ENTITY % katieent SYSTEM "katie.ent">
5 %katieent;
6
7 ]>
8
9 <refentry>
10   &katie-docinfo;
11   
12   <refmeta>
13     <refentrytitle>catherine</>
14     <manvolnum>1</>
15   </refmeta>
16   
17   <!-- Man page title -->
18   <refnamediv>
19     <refname>catherine</>
20     <refpurpose>Utility to poolize files (move them from legacy to pool location)</>
21   </refnamediv>
22
23   <!-- Arguments -->
24   <refsynopsisdiv>
25     <cmdsynopsis>
26       <command>catherine</>
27       <arg><option><replaceable>options</replaceable></></arg>
28     </cmdsynopsis>
29   </refsynopsisdiv>
30   
31   <RefSect1><Title>Description</>
32     <para>   
33       <command>catherine</command> is the command line tool to poolize files; i.e. move files from legacy locations to their corresponding pool locations.
34       </PARA>
35   </REFSECT1>
36
37   <RefSect1><Title>Options</>
38     <VariableList>
39       <varlistentry>
40         <term><option>-l/--limit</option>=<replaceable>size in kilobytes</replaceable></term>
41         <listitem>
42           <para>Set the maximum amount of data to poolize.  <emphasis>Note:</emphasis> Without this option, all files will be poolized.</para>
43         </listitem>
44       </varlistentry>
45       
46       <varlistentry>
47         <term><option>-n/--no-action</option></term>
48         <listitem>
49           <para>Don't actually do anything, just show what would be done.</para>
50         </listitem>
51       </varlistentry>
52     </VariableList>
53   </RefSect1>
54
55   <RefSect1><Title>Diagnostics</>
56     <para>
57       <command>catherine</command> returns zero on normal operation, non-zero on error.
58     </PARA>
59   </RefSect1>
60
61   &manauthor;
62   
63 </refentry>