phdc: API documentation and sample code
[platform/upstream/neard.git] / doc / neard.8
1 .\" neard(8) manual page
2 .\"
3 .\" Copyright (C) 2013 Intel Corporation
4 .\"
5 .TH NEARD "8" "7 March 2013"
6 .SH NAME
7 neard \- Near Field Communication daemon
8 .SH SYNOPSIS
9 .B neard [\-\-version] | [\-\-help]
10 .PP
11 .B neard [\-\-debug=<file1>:<file2>:...] [\-\-plugin=<plugin1>,<plugin2>,...] [\-\-noplugin=<plugin1>,<plugin2>,...] [\-\-nodaemon]
12 .SH DESCRIPTION
13 \fIneard\fP is an NFC (Near Field Communication) daemon for managing
14 NFC operations on devices running the Linux operating system. It relies
15 on the Linux kernel NFC socket and generic netlink families, and is a
16 fully modular system that can be extended through plug-ins.
17
18 It supports all 4 NFC tag types reading and writing, along with NFC LLCP
19 (peer to peer mode) in both target and initiator modes. The Simple NDEF
20 Exchange Protocol (SNEP), NDEF Push Protocol (NPP) and handover (Wi-Fi and
21 Bluetooth) protocols are implemented as separate plugins on top of LLCP sockets.
22 .P
23 .SH OPTIONS
24 The following options are supported:
25 .TP
26 .I "\-\-version"
27 Print the neard software version and exit.
28 .TP
29 .I "\-\-help"
30 Print neard's available options and exit.
31 .TP
32 .I "\-\-debug=<file1>:<file2>:..."
33 Sets how much information neard sends to the log destination (usually
34 syslog's "daemon" facility).  If the file options are omitted, then debugging
35 information from all the source files are printed. If file options are
36 present, then only debug prints from that source file are printed.
37 Example: --debug=src/service.c:plugins/wifi.c
38 .TP
39 .I "\-\-plugin=<plugin1>,<plugin2>,..."
40 Load these plugins only. The option can be a pattern containing
41 "*" and "?" characters.
42 .TP
43 .I "\-\-noplugin=<plugin1>,<plugin2>,..."
44 Never load these plugins. The option can be a pattern containing
45 "*" and "?" characters.
46 .TP
47 .I "\-\-nodaemon"
48 Do not daemonize. This is useful for debugging, and directs log output to
49 the controlling terminal in addition to syslog.
50 .TP
51 .SH SEE ALSO
52 .BR neard.conf (5).