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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE refentry PUBLIC '-//OASIS//DTD DocBook XML V4.5//EN' 'http://www.docbook.org/xml/4.5/docbookx.dtd'
[
<!ENTITY p 'sinntp'>
<!ENTITY version '1.6'>
]>
<refentry>
<refentryinfo>
<title>&p; manual</title>
<productname>&p;</productname>
<copyright>
<year>2009</year>
<year>2010</year>
<year>2011</year>
<year>2012</year>
<holder>Piotr Lewandowski</holder>
<holder>Jakub Wilk</holder>
</copyright>
</refentryinfo>
<refmeta>
<refentrytitle>&p;</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class='version'>&version;</refmiscinfo>
</refmeta>
<refnamediv>
<refname>&p;</refname>
<refpurpose>tiny non-interactive NNTP client</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&p;</command>
<arg choice='plain'><replaceable>command</replaceable></arg>
<arg choice='opt' rep='repeat'><replaceable>options</replaceable></arg>
<arg choice='opt' rep='repeat'><replaceable>args</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
<command>&p;</command> is a tiny NNTP client originally designed to work in non-interactive
mode. Following operations are supported:
</para>
<itemizedlist>
<listitem><para>sending articles to the server,</para></listitem>
<listitem><para>fetching new articles to the mbox file,</para></listitem>
<listitem><para>downloading individual messages in RFC822 format,</para></listitem>
<listitem><para>listing available newsgroups.</para></listitem>
</itemizedlist>
</refsection>
<refsection>
<title>Commands</title>
<para>
<command>&p;</command> provides following commands:
<itemizedlist>
<listitem><para>get, </para></listitem>
<listitem><para>list,</para></listitem>
<listitem><para>pull,</para></listitem>
<listitem><para>push.</para></listitem>
</itemizedlist>
Above commands may also be invoked via convenience wrappers named in
<command>nntp-<replaceable>command</replaceable></command> scheme (e.g. <command>nntp-get</command>). See
wrappers' manual pages for command synopsis and description. </para>
</refsection>
<refsection>
<title>Global options</title>
<variablelist>
<varlistentry>
<term><option>--version</option></term>
<listitem>
<para>
Show program's version number and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option></term>
<term><option>--help</option></term>
<listitem>
<para>
Show short help message end exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<term><option>--verbose</option></term>
<listitem>
<para>
Be more verbose (use multiple times to increase verbosity).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-q</option></term>
<term><option>--quiet</option></term>
<listitem>
<para>
Be less verbose (use multiple times to decrease verbosity).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p</option></term>
<term><option>--plugin=<replaceable>plugin</replaceable></option></term>
<listitem>
<para>
Load and use <replaceable>plugin</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-S</option></term>
<term><option>--server=<replaceable>host</replaceable></option></term>
<term><option>--server=<replaceable>host</replaceable>:<replaceable>port</replaceable></option></term>
<listitem>
<para>
Connect to the specified <replaceable>host</replaceable> and <replaceable>port</replaceable>. If
omitted <command>sinntp</command> will use address stored in
<filename>/etc/nntp/server</filename> file or in <varname>NNTPSERVER</varname> variable (the
latter takes precedence over the former).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-U</option></term>
<term><option>--username=<replaceable>username</replaceable></option></term>
<listitem>
<para>
Use specified <replaceable>username</replaceable> for authentication.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-P</option></term>
<term><option>--password=<replaceable>password</replaceable></option></term>
<listitem>
<para>
Use specified <replaceable>password</replaceable> for authentication.
</para>
<para>
Use with caution! The password may be visible to other users of the system.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--no-netrc</option></term>
<listitem>
<para>
Do not attempt to read authentication credentials (username, password) from the
<filename>~/.netrc</filename> file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-t</option></term>
<term><option>--timeout=<replaceable>timeout</replaceable></option></term>
<listitem>
<para>
Wait maximum <replaceable>timeout</replaceable> seconds during communication with the server.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
Also, a particular command can support additional options.
</para>
</refsection>
<refsection>
<title>Plugins</title>
<para>
Pulled and pushed messages can be altered by the plugin mechanism. Currently <command>&p;</command> package
includes following plugins:
<itemizedlist> <!-- FIXME: lack of plugin arguments' description -->
<listitem><para><command>mimify</command> - add default charset to the message when it is not present,</para></listitem>
<listitem><para><command>strip_headers</command> - strip specified headers from message.</para></listitem>
</itemizedlist>
</para>
</refsection>
<refsection>
<title>Environment variables</title>
<variablelist>
<varlistentry>
<term>NNTPSERVER</term>
<listitem>
<para>
Address of the default NNTP server. It can be overridden by <option>--server</option> option.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>XDG_DATA_HOME</term>
<listitem>
<para>
Location of sinntp data directory.
See <ulink url='https://specifications.freedesktop.org/basedir-spec/latest/'>XDG Base Directory
Specification</ulink> for details.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Files</title>
<variablelist>
<varlistentry>
<term><filename>/etc/news/server</filename></term>
<listitem>
<para>
A file with NNTP server address. Can be overridden by <varname>NNTPSERVER</varname> environment
variable or <option>--server</option> option.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename><varname>$XDG_DATA_HOME</varname>/sinntp/</filename></term>
<listitem>
<para>
Location of sinntp data files.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>See also</title>
<para>
<citerefentry>
<refentrytitle>nntp-get</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>nntp-list</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>nntp-push</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>nntp-pull</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsection>
</refentry>
<!-- vim:set ts=4 sts=4 sw=4 tw=120: -->
|
