From 4f30f3969926cc2fcbd5f55611f004279fab26e2 Mon Sep 17 00:00:00 2001 From: Bastien Nocera Date: Tue, 16 Feb 2010 13:07:44 +0000 Subject: [PATCH] Add man page for the command-line utilities --- data/Makefile.am | 4 + data/fprintd.1 | 212 +++++++++++++++++++++++++++++++++++++++++++++++ data/fprintd.pod | 102 +++++++++++++++++++++++ 3 files changed, 318 insertions(+) create mode 100644 data/fprintd.1 create mode 100644 data/fprintd.pod diff --git a/data/Makefile.am b/data/Makefile.am index bf19936..bb7723c 100644 --- a/data/Makefile.am +++ b/data/Makefile.am @@ -18,6 +18,10 @@ polkit_DATA = $(polkit_in_files:.policy.in=.policy) confdir = $(sysconfdir)/ conf_DATA = fprintd.conf +man_MANS = fprintd.1 +fprintd.1: fprintd.pod + $(AM_V_GEN) pod2man -c "" -s 1 -q none -n fprintd -r freedesktop $< > $@ + EXTRA_DIST = $(dbus_services_in_files) $(dbus_conf_DATA) $(polkit_in_files) $(conf_DATA) CLEANFILES = $(polkit_DATA) $(dbus_services_DATA) diff --git a/data/fprintd.1 b/data/fprintd.1 new file mode 100644 index 0000000..018b529 --- /dev/null +++ b/data/fprintd.1 @@ -0,0 +1,212 @@ +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.07) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.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" '' +'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 turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" 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 "fprintd 1" +.TH fprintd 1 "2010-02-16" "freedesktop" "" +.\" 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" +fprintd \- Fingerprint management daemon, and test applications +.SH "SYNOPSYS" +.IX Header "SYNOPSYS" +\&\fBfprintd-enroll\fR [username] +.PP +\&\fBfprintd-list\fR username [usernames...] +.PP +\&\fBfprintd-verify\fR [\-f finger] [usename] +.PP +\&\fBfprintd-delete\fR username [usernames...] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +This manual page documents briefly the \fBfprintd\fR command-line utilities. +.PP +The \fBfprintd\fR daemon is accessed through \fBD\-Bus\fR by those command-line utilities. +.SH "ARGUMENTS" +.IX Header "ARGUMENTS" +.IP "\fBusername\fR" 8 +.IX Item "username" +The username for the user for which you want to query or modify the fingerprint database. +.Sp +Not that \fBfprintd-list\fR and \fBfprintd-delete\fR require at least one username to be passed, and support multiple usernames. +.Sp +\&\fBfprintd-enroll\fR and \fBfprintd-verify\fR will use the current username if none are passed on the command-line. +.IP "\fB\-f finger\fR" 8 +.IX Item "-f finger" +For \fBfprintd-enroll\fR, the finger to enroll. Possible values are: +.Sp +left-thumb, +left-index-finger, +left-middle-finger, +left-ring-finger, +left-little-finger, +right-thumb, +right-index-finger, +right-middle-finger, +right-ring-finger, +right-little-finger. +.Sp +The default is automatic, selecting the first available finger for swipe devices, or all the enrolled fingers, for press devices. +.SH "TEST APPLICATIONS" +.IX Header "TEST APPLICATIONS" +.Sh "fprintd-enroll" +.IX Subsection "fprintd-enroll" +.RS 8 +Will enroll the user's right index finger into the database. +.RE +.Sh "fprintd-list" +.IX Subsection "fprintd-list" +.RS 8 +Will list the user's enrolled fingerprints. +.RE +.Sh "fprintd-verify" +.IX Subsection "fprintd-verify" +.RS 8 +Will enroll the user's right index finger into the database. +.RE +.Sh "fprintd-enroll" +.IX Subsection "fprintd-enroll" +.RS 8 +Will enroll the user's right index finger into the database. +.RE +.SH "AUTHOR" +.IX Header "AUTHOR" +\&\fBfprintd\fR was written by Bastien Nocera and Daniel Drake. +.SH "DIRECTORIES" +.IX Header "DIRECTORIES" +By default, fprintd stores the fingerprints in \fB/var/lib/fprint/\fR +.SH "SEE ALSO" +.IX Header "SEE ALSO" +.IP "\fBdbus-daemon\fR, \fBgnome-about-me\fR" 8 +.IX Item "dbus-daemon, gnome-about-me" diff --git a/data/fprintd.pod b/data/fprintd.pod new file mode 100644 index 0000000..fd9a540 --- /dev/null +++ b/data/fprintd.pod @@ -0,0 +1,102 @@ +=head1 NAME + +fprintd - Fingerprint management daemon, and test applications + +=head1 SYNOPSYS + +B [username] + +B username [usernames...] + +B [-f finger] [usename] + +B username [usernames...] + +=head1 DESCRIPTION + +This manual page documents briefly the B command-line utilities. + +The B daemon is accessed through B by those command-line utilities. + +=head1 ARGUMENTS + +=over 8 + +=item B + +The username for the user for which you want to query or modify the fingerprint database. + +Not that B and B require at least one username to be passed, and support multiple usernames. + +B and B will use the current username if none are passed on the command-line. + +=item B<-f finger> + +For B, the finger to enroll. Possible values are: + +left-thumb, +left-index-finger, +left-middle-finger, +left-ring-finger, +left-little-finger, +right-thumb, +right-index-finger, +right-middle-finger, +right-ring-finger, +right-little-finger. + +The default is automatic, selecting the first available finger for swipe devices, or all the enrolled fingers, for press devices. + +=back + +=head1 TEST APPLICATIONS + +=over 8 + +=back + +=head2 fprintd-enroll + +=over 8 + +Will enroll the user's right index finger into the database. + +=back + +=head2 fprintd-list + +=over 8 + +Will list the user's enrolled fingerprints. + +=back + +=head2 fprintd-verify + +=over 8 + +Will enroll the user's right index finger into the database. + +=back + +=head2 fprintd-enroll + +=over 8 + +Will enroll the user's right index finger into the database. + +=back + +=head1 AUTHOR + +B was written by Bastien Nocera and Daniel Drake. + +=head1 DIRECTORIES + +By default, fprintd stores the fingerprints in B + +=head1 SEE ALSO + +=over 8 + +=item B, B