summaryrefslogtreecommitdiffstats
path: root/lurker/index/lurker-regenerate.sgml
blob: e2577fb0c7fb2a83c5714873dc3db7fa76845347 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man lurker-regenerate.sgml > lurker-regenerate.1'.
     You may view the manual page with:
     `docbook-to-man lurker-regenerate.sgml | nroff -man | less'.
     A typical entry in a Makefile or Makefile.am is:

lurker-regenerate.1: lurker-regenerate.sgml
	docbook-to-man $< > $@
  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Jonas</firstname>">
  <!ENTITY dhsurname   "<surname>Meurer</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>May 22, 2003</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail    "<email>jonas@freesources.org</email>">
  <!ENTITY dhusername "Jonas Meurer">
  <!ENTITY dhucpackage "<refentrytitle>LURKER\-REGENERATE</refentrytitle>">
  <!ENTITY dhpackage   "lurker\-regenerate">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY lurker      "<productname>lurker</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2003</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>imports messages into the archive</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <arg>&lt;bin-dir&gt;</arg>
      <arg>&lt;config-file&gt;</arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para><command>&dhpackage;</command> regenerates a lurker database.
      It generates a new database first, then replaces the old one with
      the new one. You will need enough diskspace for a full copy of the
      database that you want to regenerate.
      The two arguments are optional.</para>

    <para>Regenerating the lurker database is the only way to recover
      disk space from deleted emails. If you delete an entire mailing
      list, you should regenerate the database.</para>

    <para>Be aware of the fact that lurker-regenerate supports only databases
      from lurker >= 0.6. If you want to regenerate databases from earlier
      versions of lurker, you'll need to rm -rf the whole database and reimport
      it manually.</para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>
    <variablelist>
      <varlistentry>
        <term><option>bin-dir</option></term>
        <listitem>
          <para>The directory containing lurker-{index,list,params,prune}.
                This defaults to where 'make install' placed them.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>config-file</option></term>
        <listitem>
          <para>The config-file for which lurker-regenerate rebuilds the 
                database.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>lurker\-index(1), lurker\-list(1), lurker\-params(1), lurker\-prune(1), lurker\-search(1)</para>
    <para>lurker documentation on http://lurker.sourceforge.net/</para>

  </refsect1>
  <refsect1>
    <title>COPYRIGHT</title>

    <para>
    Copyright (C) 2003-2006: &dhusername; &lt;&dhemail;&gt;
    </para>

    <para>
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; version 2.
    </para>

    <para>
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
    </para>

    <para>
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place - Suite 330,
    Boston, MA 02111-1307, USA.
    </para>
  </refsect1>

  <refsect1>
    <title>BUGS</title>

    <para>Before reporting a bug, please confirm that the bug you found is
    still present in the latest official release. If the problem persists,
    then send mail with instructions describing how to reproduce the bug to
    &lt;&support;&gt;.</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->