add XS-Vcs-Svn line to debian/control
[debian/nanobloggermail.git] / debian / nanobloggermail.1
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .TH NANOBLOGGERMAIL 1 "August  18, 2005"
3 .\" Please adjust this date whenever revising the manpage.
4 .\"
5 .\" Some roff macros, for reference:
6 .\" .nh        disable hyphenation
7 .\" .hy        enable hyphenation
8 .\" .ad l      left justify
9 .\" .ad b      justify to both left and right margins
10 .\" .nf        disable filling
11 .\" .fi        enable filling
12 .\" .br        insert line break
13 .\" .sp <n>    insert n+1 empty lines
14 .\" for manpage-specific macros, see man(7)
15
16 .SH NAME
17 nanobloggermail \- script for submitting entries to nanoblogger via mail
18
19 .SH SYNOPSIS
20 .B nb_mail
21 \fI/path/to/nanoblogger/web/\fR \fI< mail\fR
22
23 .SH DESCRIPTION
24 .B nanobloggermail
25 is a tiny perl script that takes a mail (or any other kind of
26 text) from stdin and feeds the relevant parts to nb (nanoblogger's binary).
27 It allows inserting new entries into weblogs without having shell access.
28 .TP
29 \fB/path/to/nanoblogger/web/\fR
30 Path to the directory with your nanoblogger blog; i.e. $BLOG_DIR in nanoblogger syntax.
31 .TP
32 \fBmail\fR
33 Mail (or other text), passed to nb by nb_mail.
34 .br
35 The body of the mail
36 .B
37 must
38 contain the following keywords in
39 .B
40 this
41 order and in capitals: TITLE: string CAT: integer (catid) BODY: (string)
42
43 .SH EXAMPLE
44 .B
45 nb_mail
46 /home/gregor/public_html/diary < message
47 .PP
48 with 
49 .B
50 message 
51 containing:
52 .br
53 TITLE: New software CAT: 3 BODY: Today I installed nanobloggermail and I'm very happy with it.
54
55 .SH NOTE
56 Normally you won't call nb_mail from the commandline but probably from
57 procmail or aliases; cf. the documentation.
58
59 .SH SEE ALSO
60 .B /usr/share/doc/nanobloggermail/
61 .PP
62 nanobloggermail was written by gregor herrmann 
63 .nh
64 <gregor+debian@comodo.priv.at>.