summaryrefslogtreecommitdiff
path: root/debian/bbdb-srv.pl.1
diff options
context:
space:
mode:
Diffstat (limited to 'debian/bbdb-srv.pl.1')
-rw-r--r--debian/bbdb-srv.pl.160
1 files changed, 60 insertions, 0 deletions
diff --git a/debian/bbdb-srv.pl.1 b/debian/bbdb-srv.pl.1
new file mode 100644
index 0000000..86f83da
--- /dev/null
+++ b/debian/bbdb-srv.pl.1
@@ -0,0 +1,60 @@
+.\" Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH BBDB-SRV.PL 1 "March 31, 2002"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh disable hyphenation
+.\" .hy enable hyphenation
+.\" .ad l left justify
+.\" .ad b justify to both left and right margins
+.\" .nf disable filling
+.\" .fi enable filling
+.\" .br insert line break
+.\" .sp <n> insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+bbdb-srv.pl \- Converts Mail-Headers to an Emacs-Lisp String.
+.SH SYNOPSIS
+.B echo "Some Headers" | bbdb-srv.pl
+.SH DESCRIPTION
+This script reads a block of message headers on stdin, and converts them
+to an emacs-lisp string (quoting all dangerous characters) and then
+uses the `gnudoit' program to cause a running Emacs process to invoke
+the `bbdb-srv' function with that string.
+
+This has the effect of causing the running Emacs to display the BBDB
+record corresponding to these headers.
+
+See the Emacs side of things in bbdb-srv.el for more info.
+
+A trivial application of this is the shell command:
+
+ echo 'From: Jamie Zawinski <jwz@netscape.com>' | bbdb-srv.perl
+
+which will cause the corresponding record to be displayed.
+A more interesting application of this is:
+
+ setenv NS_MSG_DISPLAY_HOOK bbdb-srv.perl
+
+which will hook BBDB up to Mozilla (Unix Netscape Mail and Netscape News
+versions 3.0b2 and later only.)
+
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+Instead, it has documentation in the GNU Info format; see below.
+.SH SEE ALSO
+.BR bbdb-areacode-split.pl (1),
+.BR bbdb-unlazy-lock.pl (1).
+.BR bbdb-srv.pl (1).
+.br
+The bbdb is fully documented by
+.IR "The insidious Big Brother Database for mail and news" ,
+available via the Infonode
+.BR bbdb
+.
+.SH AUTHOR
+This manual page was written by Joerg Jaspert (JJ) <joerg@goliathbbs.dnsalias.net>,
+for the Debian GNU/Linux system (but may be used by others).