← Back to branch summary

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

« back to all changes in this revision

Viewing changes to index/lurker-list.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-list.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-list.sgml > lurker-list.1'.
 
5
     You may view the manual page with:
 
6
     `docbook-to-man lurker-list.sgml | nroff -man | less'.
 
7
     A typical entry in a Makefile or Makefile.am is:
 
8
 
 
9
lurker-list.1: lurker-list.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\-LIST</refentrytitle>">
 
25
  <!ENTITY dhpackage   "lurker\-list">
 
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 lists 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>\-i \-g \-t \-a \-l \-d \-s \-o</arg>
 
62
      <arg>listid ...</arg>
 
63
    </cmdsynopsis>
 
64
  </refsynopsisdiv>
 
65
  <refsect1>
 
66
    <title>DESCRIPTION</title>
 
67
 
 
68
    <para><command>&dhpackage;</command> outputs various lurker settings
 
69
    from the config file for use in shell scripts.  Do not use sed/grep/etc,
 
70
    instead use this as it respects include.</para>
 
71
    
 
72
    <para>If no list ids are given, then all lists are dumped. If no field
 
73
    is specified, then all fields are dumped.</para>
 
74
 
 
75
  </refsect1>
 
76
  <refsect1>
 
77
    <title>OPTIONS</title>
 
78
    <variablelist>
 
79
      <varlistentry>
 
80
        <term><option>\-c config-file</option></term>
 
81
        <listitem>
 
82
          <para>Use this config file for lurker settings.</para>
 
83
        </listitem>
 
84
      </varlistentry>
 
85
      <varlistentry>
 
86
        <term><option>\-f locale</option></term>
 
87
        <listitem>
 
88
          <para>Choose lurker config fields from the specified locale
 
89
          (it defaults to selecting the fallback case for each field).</para>
 
90
        </listitem>
 
91
      </varlistentry>
 
92
      <varlistentry>
 
93
        <term><option>\-i</option></term>
 
94
        <listitem>
 
95
          <para>Output only the list id</para>
 
96
        </listitem>
 
97
      </varlistentry>
 
98
      <varlistentry>
 
99
        <term><option>\-g</option></term>
 
100
        <listitem>
 
101
          <para>Output only the group</para>
 
102
        </listitem>
 
103
      </varlistentry>
 
104
      <varlistentry>
 
105
        <term><option>\-t</option></term>
 
106
        <listitem>
 
107
          <para>Output only the title</para>
 
108
        </listitem>
 
109
      </varlistentry>
 
110
      <varlistentry>
 
111
        <term><option>\-a</option></term>
 
112
        <listitem>
 
113
          <para>Output only the email address</para>
 
114
        </listitem>
 
115
      </varlistentry>
 
116
      <varlistentry>
 
117
        <term><option>\-l</option></term>
 
118
        <listitem>
 
119
          <para>Output only the url link</para>
 
120
        </listitem>
 
121
      </varlistentry>
 
122
      <varlistentry>
 
123
        <term><option>\-d</option></term>
 
124
        <listitem>
 
125
          <para>Output only the description</para>
 
126
        </listitem>
 
127
      </varlistentry>
 
128
      <varlistentry>
 
129
        <term><option>\-s</option></term>
 
130
        <listitem>
 
131
          <para>Output only the language</para>
 
132
        </listitem>
 
133
      </varlistentry>
 
134
      <varlistentry>
 
135
        <term><option>\-o</option></term>
 
136
        <listitem>
 
137
          <para>Output only the offline status</para>
 
138
        </listitem>
 
139
      </varlistentry>
 
140
    </variablelist>
 
141
  </refsect1>
 
142
  <refsect1>
 
143
    <title>SEE ALSO</title>
 
144
    
 
145
    <para>lurker\-index(1), lurker\-prune(1), lurker\-params(1), lurker\-search(1)</para>
 
146
    <para>lurker documentation on http://lurker.sourceforge.net/</para>
 
147
 
 
148
  </refsect1>
 
149
  <refsect1>
 
150
    <title>COPYRIGHT</title>
 
151
 
 
152
    <para>
 
153
    Copyright (C) 2002: &dhusername; &lt;&dhemail;&gt;
 
154
    </para>
 
155
 
 
156
    <para>
 
157
    This program is free software; you can redistribute it and/or modify
 
158
    it under the terms of the GNU General Public License as published by
 
159
    the Free Software Foundation; version 2.
 
160
    </para>
 
161
    
 
162
    <para>
 
163
    This program is distributed in the hope that it will be useful,
 
164
    but WITHOUT ANY WARRANTY; without even the implied warranty of
 
165
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
166
    GNU General Public License for more details.
 
167
    </para>
 
168
    
 
169
    <para>
 
170
    You should have received a copy of the GNU General Public License
 
171
    along with this program; if not, write to the Free Software
 
172
    Foundation, Inc., 59 Temple Place - Suite 330,
 
173
    Boston, MA 02111-1307, USA.
 
174
    </para>
 
175
  </refsect1>
 
176
  
 
177
  <refsect1>
 
178
    <title>BUGS</title>
 
179
 
 
180
    <para>Before reporting a bug, please confirm that the bug you found is
 
181
    still present in the latest official release. If the problem persists,
 
182
    then send mail with instructions describing how to reproduce the bug to
 
183
    &lt;&support;&gt;.</para>
 
184
 
 
185
  </refsect1>
 
186
</refentry>
 
187
 
 
188
<!-- Keep this comment at the end of the file
 
189
Local variables:
 
190
mode: sgml
 
191
sgml-omittag:t
 
192
sgml-shorttag:t
 
193
sgml-minimize-attributes:nil
 
194
sgml-always-quote-attributes:t
 
195
sgml-indent-step:2
 
196
sgml-indent-data:t
 
197
sgml-parent-document:nil
 
198
sgml-default-dtd-file:nil
 
199
sgml-exposed-tags:nil
 
200
sgml-local-catalogs:nil
 
201
sgml-local-ecat-files:nil
 
202
End:
 
203
-->