diff options
author | Peter Hutterer <peter.hutterer@who-t.net> | 2013-12-09 08:42:17 +1000 |
---|---|---|
committer | Peter Hutterer <peter.hutterer@who-t.net> | 2013-12-09 08:46:24 +1000 |
commit | 94628309f903426b7122db83687fa6fea617ef6a (patch) | |
tree | 42c45445a762c0f36cf45645c240de4cd7161236 | |
parent | 08a7773ef88c3e9d86a4d589c8c885a050bf2c51 (diff) | |
download | libevdev-94628309f903426b7122db83687fa6fea617ef6a.tar.gz |
doc: add a placeholder man page
We don't provide man pages (the ones created by doxygen are pretty
terrible) so provide a placeholder page to provide the minimum info and point
people in the right direction.
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
-rw-r--r-- | configure.ac | 1 | ||||
-rw-r--r-- | doc/.gitignore | 1 | ||||
-rw-r--r-- | doc/Makefile.am | 2 | ||||
-rw-r--r-- | doc/libevdev.man.in | 32 |
4 files changed, 36 insertions, 0 deletions
diff --git a/configure.ac b/configure.ac index 9e122f0..5e3b40c 100644 --- a/configure.ac +++ b/configure.ac @@ -129,6 +129,7 @@ AC_CONFIG_FILES([Makefile libevdev/Makefile doc/Makefile doc/libevdev.doxygen + doc/libevdev.man tools/Makefile test/Makefile libevdev.pc]) diff --git a/doc/.gitignore b/doc/.gitignore index 823fa26..20b4ef5 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -1,2 +1,3 @@ html/ libevdev.doxygen +libevdev.man diff --git a/doc/Makefile.am b/doc/Makefile.am index 7fe9096..c1a06aa 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,3 +1,5 @@ +man3_MANS = libevdev.man + if HAVE_DOXYGEN noinst_DATA = html/index.html diff --git a/doc/libevdev.man.in b/doc/libevdev.man.in new file mode 100644 index 0000000..58a15c7 --- /dev/null +++ b/doc/libevdev.man.in @@ -0,0 +1,32 @@ +.TH LIBEVDEV 3 @PACKAGE_VERSION@ +.SH NAME +libevdev \- wrapper library for evdev devices +.SH SYNOPSIS +.HP +#include <libevdev/libevdev.h> +.PP +int +.B libevdev_new_from_fd +(int fd, struct libevdev **device) +.PP +void +.B libevdev_free +(struct libevdev *device) + +.SH DESCRIPTION +.PP +.B libevdev +is a wrapper library for evdev devices. it moves the common +tasks when dealing with evdev devices into a library and provides a library +interface to the callers, thus avoiding erroneous ioctls, etc. +.PP +This man page is a placeholder only. The documentation for this version of +.B libevdev +is available at: +.PP +.B http://www.freedesktop.org/software/libevdev/doc/@PACKAGE_VERSION@/ +.SH LICENSE +.B libevdev +is licensed under the MIT license. + + |