doc: Add neard man pages

One man page for the daemon and another one for the configuration file.

diff --git a/Makefile.am b/Makefile.am
index 8fd6675..023c9fb 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -73,6 +73,8 @@ doc_files = doc/manager-api.txt doc/tag-api.txt doc/device-api.txt doc/adapter-a
 
 EXTRA_DIST = src/genbuiltin $(doc_files)
 
+dist_man_MANS = doc/neard.8 doc/neard.conf.5
+
 test_scripts = test/disable-adapter test/enable-adapter test/list-adapters \
                test/dump-device test/dump-tag test/dump-record \
                test/monitor-near test/start-poll test/stop-poll test/write-tag \

diff --git a/doc/neard.8 b/doc/neard.8
new file mode 100644 (file)
index 0000000..7139eb5
--- /dev/null
+++ b/doc/neard.8
@@ -0,0 +1,52 @@
+.\" neard(8) manual page
+.\"
+.\" Copyright (C) 2013 Intel Corporation
+.\"
+.TH NEARD "8" "7 March 2013"
+.SH NAME
+neard \- Near Field Communication daemon
+.SH SYNOPSIS
+.B neard [\-\-version] | [\-\-help]
+.PP
+.B neard [\-\-debug=<file1>:<file2>:...] [\-\-plugin=<plugin1>,<plugin2>,...] [\-\-noplugin=<plugin1>,<plugin2>,...] [\-\-nodaemon]
+.SH DESCRIPTION
+\fIneard\fP is an NFC (Near Field Communication) daemon for managing
+NFC operations on devices running the Linux operating system. It relies
+on the Linux kernel NFC socket and generic netlink families, and is a
+fully modular system that can be extended through plug-ins.
+
+It supports all 4 NFC tag types reading and writing, along with NFC LLCP
+(peer to peer mode) in both target and initiator modes. The Simple NDEF
+Exchange Protocol (SNEP), NDEF Push Protocol (NPP) and handover (Wi-Fi and
+Bluetooth) protocols are implemented as separate plugins on top of LLCP sockets.
+.P
+.SH OPTIONS
+The following options are supported:
+.TP
+.I "\-\-version"
+Print the neard software version and exit.
+.TP
+.I "\-\-help"
+Print neard's available options and exit.
+.TP
+.I "\-\-debug=<file1>:<file2>:..."
+Sets how much information neard sends to the log destination (usually
+syslog's "daemon" facility).  If the file options are omitted, then debugging
+information from all the source files are printed. If file options are
+present, then only debug prints from that source file are printed.
+Example: --debug=src/service.c:plugins/wifi.c
+.TP
+.I "\-\-plugin=<plugin1>,<plugin2>,..."
+Load these plugins only. The option can be a pattern containing
+"*" and "?" characters.
+.TP
+.I "\-\-noplugin=<plugin1>,<plugin2>,..."
+Never load these plugins. The option can be a pattern containing
+"*" and "?" characters.
+.TP
+.I "\-\-nodaemon"
+Do not daemonize. This is useful for debugging, and directs log output to
+the controlling terminal in addition to syslog.
+.TP
+.SH SEE ALSO
+.BR neard.conf (5).

diff --git a/doc/neard.conf.5 b/doc/neard.conf.5
new file mode 100644 (file)
index 0000000..e883b8b
--- /dev/null
+++ b/doc/neard.conf.5
@@ -0,0 +1,39 @@
+.\" neard.conf(5) manual page
+.\"
+.\" Copyright (C) 2013 Intel Corporation
+.\"
+.TH "neard.conf" "5" "7 March 2013" ""
+.SH NAME
+main.conf \- neard configuration file
+.SH SYNOPSIS
+/etc/neard/main.conf
+.br
+or
+.br
+\fI<SYSCONFDIR>\fP/neard/main.conf
+.br
+where <SYSCONFDIR> depends on your distribution or build.
+.SH DESCRIPTION
+.P
+.I main.conf
+is a configuration file for \fBneard\fP (8). The configuration file is
+optional but it can be used to set up various aspects of neard's
+behavior.
+.SH "FILE FORMAT"
+.P
+The configuration file format is key file format.
+It consists of sections (groups) of key-value pairs.
+Lines beginning with a '#' and blank lines are considered comments.
+Sections are started by a header line containing the section enclosed
+in '[' and ']', and ended implicitly by the start of the next section
+or the end of the file. Each key-value pair must be contained in a section.
+.P
+Description of sections and available keys follows:
+.SS [General]
+This section is the only mandatory section of the configuration file.
+.TP
+.B ConstantPoll=\fPtrue|false\fP
+Enable constant polling. Default is false. Constant polling will force neard
+into starting a new polling cycle whenever a target or a device are lost.
+.SH "SEE ALSO"
+.BR neard (8)