← Back to branch summary

~ubuntu-branches/ubuntu/raring/lurker/raring

« back to all changes in this revision

Viewing changes to index/lurker-params.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Jonas Meurer
  • Date: 2004-09-26 16:27:51 UTC
  • Revision ID: james.westby@ubuntu.com-20040926162751-z1ohcjltv7ojtg6z
Tags: upstream-1.2
Import upstream version 1.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
index/lurker-params.sgml
 
1
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
 
2
 
 
3
<!-- Process this file with docbook-to-man to generate an nroff manual
 
4
     page: `docbook-to-man lurker-params.sgml > lurker-params.1'.
 
5
     You may view the manual page with:
 
6
     `docbook-to-man lurker-params.sgml | nroff -man | less'.
 
7
     A typical entry in a Makefile or Makefile.am is:
 
8
 
 
9
lurker-params.1: lurker-params.sgml
 
10
        docbook-to-man $< > $@
 
11
  -->
 
12
 
 
13
  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
 
14
  <!ENTITY dhfirstname "<firstname>Wesley W.</firstname>">
 
15
  <!ENTITY dhsurname   "<surname>Terpstra</surname>">
 
16
  <!-- Please adjust the date whenever revising the manpage. -->
 
17
  <!ENTITY dhdate      "<date>Jun 4, 2003</date>">
 
18
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
 
19
       allowed: see man(7), man(1). -->
 
20
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
 
21
  <!ENTITY dhemail     "<email>terpstra@users.sourceforge.net</email>">
 
22
  <!ENTITY dhusername  "Wesley W. Terpstra">
 
23
  <!ENTITY support     "<email>lurker\-users@lists.sourceforge.net</email>">
 
24
  <!ENTITY dhucpackage "<refentrytitle>LURKER\-PARAMS</refentrytitle>">
 
25
  <!ENTITY dhpackage   "lurker\-params">
 
26
 
 
27
  <!ENTITY lurker      "<productname>lurker</productname>">
 
28
  <!ENTITY gnu         "<acronym>GNU</acronym>">
 
29
]>
 
30
 
 
31
<refentry>
 
32
  <refentryinfo>
 
33
    <address>
 
34
      &dhemail;
 
35
    </address>
 
36
    <author>
 
37
      &dhfirstname;
 
38
      &dhsurname;
 
39
    </author>
 
40
    <copyright>
 
41
      <year>2003</year>
 
42
      <holder>&dhusername;</holder>
 
43
    </copyright>
 
44
    &dhdate;
 
45
  </refentryinfo>
 
46
  <refmeta>
 
47
    &dhucpackage;
 
48
 
 
49
    &dhsection;
 
50
  </refmeta>
 
51
  <refnamediv>
 
52
    <refname>&dhpackage;</refname>
 
53
 
 
54
    <refpurpose>parses parameters from the config file</refpurpose>
 
55
  </refnamediv>
 
56
  <refsynopsisdiv>
 
57
    <cmdsynopsis>
 
58
      <command>&dhpackage;</command>
 
59
      <arg>\-c &lt;config-file&gt;</arg>
 
60
      <arg>\-f &lt;locale&gt;</arg>
 
61
      <arg>\-d \-a \-n \-e \-x \-m \-i \-w \-h \-r \-g</arg>
 
62
    </cmdsynopsis>
 
63
  </refsynopsisdiv>
 
64
  <refsect1>
 
65
    <title>DESCRIPTION</title>
 
66
 
 
67
    <para><command>&dhpackage;</command> outputs various lurker settings
 
68
    from the config file for use in shell scripts.  Do not use sed/grep/etc,
 
69
    instead use this as it respects include.  </para>
 
70
 
 
71
  </refsect1>
 
72
  <refsect1>
 
73
    <title>OPTIONS</title>
 
74
    <variablelist>
 
75
      <varlistentry>
 
76
        <term><option>\-c config-file</option></term>
 
77
        <listitem>
 
78
          <para>Use this config file for lurker settings.</para>
 
79
        </listitem>
 
80
      </varlistentry>
 
81
      <varlistentry>
 
82
        <term><option>\-f locale</option></term>
 
83
        <listitem>
 
84
          <para>Choose lurker config fields from the specified locale
 
85
          (it defaults to selecting the fallback case for each field).</para>
 
86
        </listitem>
 
87
      </varlistentry>
 
88
      <varlistentry>
 
89
        <term><option>\-d</option></term>
 
90
        <listitem>
 
91
          <para>Output only the dbdir parameter</para>
 
92
        </listitem>
 
93
      </varlistentry>
 
94
      <varlistentry>
 
95
        <term><option>\-a</option></term>
 
96
        <listitem>
 
97
          <para>Output only the archive parameter</para>
 
98
        </listitem>
 
99
      </varlistentry>
 
100
      <varlistentry>
 
101
        <term><option>\-n</option></term>
 
102
        <listitem>
 
103
          <para>Output only the administrator name</para>
 
104
        </listitem>
 
105
      </varlistentry>
 
106
      <varlistentry>
 
107
        <term><option>\-e</option></term>
 
108
        <listitem>
 
109
          <para>Output only the administrator email address</para>
 
110
        </listitem>
 
111
      </varlistentry>
 
112
      <varlistentry>
 
113
        <term><option>\-x</option></term>
 
114
        <listitem>
 
115
          <para>Output only the xslt processing command</para>
 
116
        </listitem>
 
117
      </varlistentry>
 
118
      <varlistentry>
 
119
        <term><option>\-m</option></term>
 
120
        <listitem>
 
121
          <para>Output only the mime pgp verifying command</para>
 
122
        </listitem>
 
123
      </varlistentry>
 
124
      <varlistentry>
 
125
        <term><option>\-i</option></term>
 
126
        <listitem>
 
127
          <para>Output only the inline pgp verifying command</para>
 
128
        </listitem>
 
129
      </varlistentry>
 
130
      <varlistentry>
 
131
        <term><option>\-w</option></term>
 
132
        <listitem>
 
133
          <para>Output only the web_cache state</para>
 
134
        </listitem>
 
135
      </varlistentry>
 
136
      <varlistentry>
 
137
        <term><option>\-h</option></term>
 
138
        <listitem>
 
139
          <para>Output only the hide_email state</para>
 
140
        </listitem>
 
141
      </varlistentry>
 
142
      <varlistentry>
 
143
        <term><option>\-r</option></term>
 
144
        <listitem>
 
145
          <para>Output only the raw_email state</para>
 
146
        </listitem>
 
147
      </varlistentry>
 
148
      <varlistentry>
 
149
        <term><option>\-g</option></term>
 
150
        <listitem>
 
151
          <para>Output only the regroupable state</para>
 
152
        </listitem>
 
153
      </varlistentry>
 
154
    </variablelist>
 
155
  </refsect1>
 
156
  <refsect1>
 
157
    <title>SEE ALSO</title>
 
158
    
 
159
    <para>lurker\-index(1), lurker\-prune(1), lurker\-list(1), lurker\-search(1)</para>
 
160
    <para>lurker documentation on http://lurker.sourceforge.net/</para>
 
161
 
 
162
  </refsect1>
 
163
  <refsect1>
 
164
    <title>COPYRIGHT</title>
 
165
 
 
166
    <para>
 
167
    Copyright (C) 2002: &dhusername; &lt;&dhemail;&gt;
 
168
    </para>
 
169
 
 
170
    <para>
 
171
    This program is free software; you can redistribute it and/or modify
 
172
    it under the terms of the GNU General Public License as published by
 
173
    the Free Software Foundation; version 2.
 
174
    </para>
 
175
    
 
176
    <para>
 
177
    This program is distributed in the hope that it will be useful,
 
178
    but WITHOUT ANY WARRANTY; without even the implied warranty of
 
179
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
180
    GNU General Public License for more details.
 
181
    </para>
 
182
    
 
183
    <para>
 
184
    You should have received a copy of the GNU General Public License
 
185
    along with this program; if not, write to the Free Software
 
186
    Foundation, Inc., 59 Temple Place - Suite 330,
 
187
    Boston, MA 02111-1307, USA.
 
188
    </para>
 
189
  </refsect1>
 
190
  
 
191
  <refsect1>
 
192
    <title>BUGS</title>
 
193
 
 
194
    <para>Before reporting a bug, please confirm that the bug you found is
 
195
    still present in the latest official release. If the problem persists,
 
196
    then send mail with instructions describing how to reproduce the bug to
 
197
    &lt;&support;&gt;.</para>
 
198
 
 
199
  </refsect1>
 
200
</refentry>
 
201
 
 
202
<!-- Keep this comment at the end of the file
 
203
Local variables:
 
204
mode: sgml
 
205
sgml-omittag:t
 
206
sgml-shorttag:t
 
207
sgml-minimize-attributes:nil
 
208
sgml-always-quote-attributes:t
 
209
sgml-indent-step:2
 
210
sgml-indent-data:t
 
211
sgml-parent-document:nil
 
212
sgml-default-dtd-file:nil
 
213
sgml-exposed-tags:nil
 
214
sgml-local-catalogs:nil
 
215
sgml-local-ecat-files:nil
 
216
End:
 
217
-->