mirror of
https://github.com/obgm/libcoap.git
synced 2026-11-06 17:52:54 +03:00
Carsten Schoenert
3e9afb1460
This commmit adds the build of man pages for the binaries from the example/ folder, in detail these are coap-client.5, coap-rd.5 and coap-server.5. The source of the man pages is written in asciidoc so the build environment must have access to a installed asciidoc package.
89 lines
1.8 KiB
Plaintext
89 lines
1.8 KiB
Plaintext
// -*- mode:doc; -*-
|
|
// vim: set syntax=asciidoc,tw=0:
|
|
|
|
coap-server(5)
|
|
==============
|
|
:doctype: manpage
|
|
:man source: coap-server
|
|
:man version: @PACKAGE_VERSION@
|
|
:man manual: coap-server Manual
|
|
|
|
NAME
|
|
-----
|
|
coap-server - CoAP Server based on libcoap
|
|
|
|
SYNOPSIS
|
|
--------
|
|
*coap-server* [*-A* addr] [*-g* group] [*-p* port] [*-v* num]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
*coap-server* is a CoAP server which simulate 6LoWPAN devices which can be
|
|
addressed via the CoAP protocol.
|
|
|
|
OPTIONS
|
|
-------
|
|
*-A* addr::
|
|
The local address of the interface which the server has to listen.
|
|
|
|
*-g* group::
|
|
Join specified multicast 'group' on startup.
|
|
|
|
*-p* port::
|
|
The 'port' on the given address the server will be waitung for connections.
|
|
The default port is 5683 if not given any other value.
|
|
|
|
*-v* num::
|
|
The verbosity level to use (default: 3, maximum is 9).
|
|
|
|
EXAMPLES
|
|
--------
|
|
* Example
|
|
----
|
|
coap-server -A ::1
|
|
----
|
|
Let the server listen on localhost (port 5683).
|
|
|
|
* Example
|
|
----
|
|
coap-server -A ::1 -p 13011
|
|
----
|
|
Quite the same, except listening port is '13011' (and not the default port
|
|
5683).
|
|
|
|
* Example
|
|
----
|
|
coap-server -A 2001:db8:81a8:0:6ef0:dead:feed:beef -v 5
|
|
----
|
|
The listening address is set to '2001:db8:81a8:0:6ef0:dead:feed:beef' and the
|
|
verbosity level is set to '5'.
|
|
|
|
* Example
|
|
----
|
|
coap-server -A 2001:db8:81a8:0:6ef0:dead:feed:beef -g FF02:FD
|
|
----
|
|
Set listening address to '2001:db8:81a8:0:6ef0:dead:feed:beef' and join the
|
|
All CoAP Nodes multicast group 'FF02:FD'.
|
|
|
|
FILES
|
|
------
|
|
There are no configuration files.
|
|
|
|
EXIT STATUS
|
|
-----------
|
|
*0*::
|
|
Success
|
|
|
|
*1*::
|
|
Failure (syntax or usage error; configuration error; document
|
|
processing failure; unexpected error)
|
|
|
|
BUGS
|
|
-----
|
|
Please report bugs on the mailing list for libcoap:
|
|
libcoap-developers@lists.sourceforge.net
|
|
|
|
AUTHORS
|
|
-------
|
|
The libcoap project <libcoap-developers@lists.sourceforge.net>
|