Skip to content

Commit

Permalink
Added man pages output.
Browse files Browse the repository at this point in the history
  • Loading branch information
opencrypto committed Jun 3, 2018
1 parent 6e8b7c6 commit dc770a2
Show file tree
Hide file tree
Showing 2 changed files with 686 additions and 0 deletions.
221 changes: 221 additions & 0 deletions docs/ocspd.3
@@ -0,0 +1,221 @@
.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "ocspd.3 3"
.TH ocspd.3 3 "2018-06-02" "openca-ocspd 3.1.2" "OpenCA Contributed Manual"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
.Vb 1
\& openca\-ocspd \- OCSP Daemon
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBopenca-ocspd\fR
[\fB\-d\fR]
[\fB\-p n\fR]
[\fB\-b address\fR]
[\fB\-c file\fR]
[\fB\-md digest\fR]
[\fB\-k passwd\fR]
[\fB\-i passin\fR]
[\fB\-e engine\fR]
[\fB\-r chroot_dir\fR]
[\fB\-v\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \fBopenca-ocspd\fR is an \s-1RFC2560\s0 compliant \s-1OCSPD\s0 responder. It can
be used to verify the status of a certificate using \s-1OCSP\s0 clients
(such as Mozilla/Netscape7).
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-d\fR" 4
.IX Item "-d"
detach the main process from the calling process.
.IP "\fB\-p n\fR" 4
.IX Item "-p n"
specifies the port to bind to. Default is 2560.
.IP "\fB\-b address\fR" 4
.IX Item "-b address"
specifies the \s-1IP\s0 address to bind to. Default behaviour is to listen
to every \s-1IP\s0 available (equal to '*' value).
.IP "\fB\-c file\fR" 4
.IX Item "-c file"
specifies the configuration file to be loaded. Default file loaded
is \fB/usr/local/etc/ocspd.conf\fR.
.IP "\fB\-md digest\fR" 4
.IX Item "-md digest"
specifies the digest to be used when generating responses. Default is
sha1.
.IP "\fB\-k passwd\fR" 4
.IX Item "-k passwd"
specifies the password to be used when loading the private key.
.IP "\fB\-i passin\fR" 4
.IX Item "-i passin"
the key password source. For more information about the format of \fBarg\fR
see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
.IP "\fB\-engine id\fR" 4
.IX Item "-engine id"
specifying an engine (by it's unique \fBid\fR string) will cause the responder
to attempt to obtain a functional reference to the specified engine,
thus initialising it if needed. The engine will then be set as the default
for all available algorithms.
.IP "\fB\-r chroot_dir\fR" 4
.IX Item "-r chroot_dir"
Chroot the application into the specified directory.
.IP "\fB\-v\fR" 4
.IX Item "-v"
this prints extra details about the operations being performed.
.SH "NOTES"
.IX Header "NOTES"
.RS 4
Actually not extensive testing has been carried out, anyway this daemon
is reported to work with Mozilla/Netscape.
.Sp
To reload the certificate's db simply send a \s-1SIGHUP\s0 to the main process
( kill \-s \s-1SIGHUP\s0 pid ).
.RE
.SH "EXAMPLE"
.IX Header "EXAMPLE"
.Vb 1
\& openca\-ocspd \-c contrib/ocspd.conf
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
.RS 4
Massimiliano Pala <madwolf@openca.org>
.RE
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.RS 4
\&\fIopenca\fR\|(3),\fIopenssl\fR\|(1), \fIocsp\fR\|(1)
.RE

0 comments on commit dc770a2

Please sign in to comment.