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>
This commit is contained in:
Peter Hutterer 2013-12-09 08:42:17 +10:00
parent 08a7773ef8
commit 94628309f9
4 changed files with 36 additions and 0 deletions

View file

@ -129,6 +129,7 @@ AC_CONFIG_FILES([Makefile
libevdev/Makefile
doc/Makefile
doc/libevdev.doxygen
doc/libevdev.man
tools/Makefile
test/Makefile
libevdev.pc])

1
doc/.gitignore vendored
View file

@ -1,2 +1,3 @@
html/
libevdev.doxygen
libevdev.man

View file

@ -1,3 +1,5 @@
man3_MANS = libevdev.man
if HAVE_DOXYGEN
noinst_DATA = html/index.html

32
doc/libevdev.man.in Normal file
View file

@ -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.