Signed-off-by: Peter Hutterer <[email protected]> --- Ping, feel free to use this man page in linuxwacom too.
configure.ac | 1 + man/Makefile.am | 19 +++++++--- man/xsetwacom.man | 93 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 107 insertions(+), 6 deletions(-) create mode 100644 man/xsetwacom.man diff --git a/configure.ac b/configure.ac index 22d5760..ee77259 100644 --- a/configure.ac +++ b/configure.ac @@ -41,6 +41,7 @@ AC_PROG_LIBTOOL # Checks for programs. AC_PROG_CC AC_PROG_INSTALL +AC_PROG_SED # Checks for libraries. AC_CHECK_LIB([m], [rint]) diff --git a/man/Makefile.am b/man/Makefile.am index 7dbc3fa..f5b1c05 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -24,14 +24,17 @@ # drivermandir = $(DRIVER_MAN_DIR) - driverman_PRE = @[email protected] - driverman_DATA = $(driverman_PRE:m...@driver_man_suffix@) -EXTRA_DIST = @[email protected] +xsetwacommandir = $(APP_MAN_DIR) +xsetwacomman_PRE = xsetwacom.man +xsetwacomman_DATA = $(xsetwacomman_PRE:m...@app_man_suffix@) + -CLEANFILES = $(driverman_DATA) +EXTRA_DIST = @[email protected] xsetwacom.man + +CLEANFILES = $(driverman_DATA) $(xsetwacomman_DATA) # Strings to replace in man pages XORGRELSTRING = @PACKAGE_STRING@ @@ -47,9 +50,13 @@ MAN_SUBSTS = \ -e 's|__drivermansuffix__|$(DRIVER_MAN_SUFFIX)|g' \ -e 's|__adminmansuffix__|$(ADMIN_MAN_SUFFIX)|g' \ -e 's|__miscmansuffix__|$(MISC_MAN_SUFFIX)|g' \ - -e 's|__filemansuffix__|$(FILE_MAN_SUFFIX)|g' + -e 's|__filemansuffix__|$(FILE_MAN_SUFFIX)|g' \ + -e 's|__drivername__|$(DRIVER_NAME)|g' -SUFFIXES = .$(DRIVER_MAN_SUFFIX) .man +SUFFIXES = .$(DRIVER_MAN_SUFFIX) $(APP_MAN_SUFFIX) .man .man.$(DRIVER_MAN_SUFFIX): $(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@ +.man.$(APP_MAN_SUFFIX): + $(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@ + diff --git a/man/xsetwacom.man b/man/xsetwacom.man new file mode 100644 index 0000000..1f3fccb --- /dev/null +++ b/man/xsetwacom.man @@ -0,0 +1,93 @@ +.\" shorthand for double quote that works everywhere. +.ds q \N'34' +.TH xsetwacom __appmansuffix__ __vendorversion__ +.SH NAME +.LP +xsetwacom \- commandline utility to query and modify __drivername__ driver settings. +.SH "SYNOPSIS" +.LP +xsetwacom [options] command [device_name] [parameter] [value] + +.SH "DESCRIPTION" +.LP +This program queries or changes properties on the devices loaded by the +__drivername__ driver. The modification of properties happens at runtime +and is not persistent through X server restarts. +.SH "GENERAL OPTIONS" +.TP +\fB-d, --display\fR display_name +Connect to the X server specified in display_name; see X(__miscmansuffix__). +.TP +\fB-h, --help\fR +Prints a short help. +.TP +\fB-v, --verbose\fR +Enable verbose output, useful for debugging. +.TP +\fB-V, --version\fR +Display version number and exit. + +.SH "COMMANDS" +.LP +Allowed commands are +.B list, +.B get, +and +.B set. +The command may be specified with our without one or two preceding +dashes, i.e. +.B --list +is equivalent to +.B -list +and +.B list. + +.SS "LIST COMMANDS" +.TP +\fBlist\fR dev +List known devices. Only input devices managed by the __drivername__ +driver are listed. +.TP +\fBlist\fR param +List known parameters. List all parameters suitable for the +.B get +or the +.B set +command. Note that not all parameters are available on all device types. +.TP +\fBlist\fR mods +.B Not implemented! +List the available list of modifiers to be used when setting key or button +actions. + +.SS "GET COMMANDS" +.TP +\fBget\fR device_name parameter +Get the current settings for the parameter on the given device. Note that +not all parameters are available on all device types. The special parameter +name "all" may be provided to display all current settings on the device. +.TP +By default, options are printed on the commandline in the respective format. The output format may be altered with one of the following options: +.TP +\fB-s, --shell\fR +Display the output in shell format, i.e. as shell commands to xsetwacom to +reproduce the same parameter. +.TP +\fB-x, --xconf\fR +Display the output in xorg.conf format, i.e. as option lines that may be +added to the InputDevice section in the xorg.conf. + +.SS "SET COMMANDS" +.TP +\fBset\fR device_name parameter value +Set the parameter value on the given device to the value provided. Note that +not all parameters are writable, some are read-only and result in an error +when trying to be modified. + +.SH "AUTHORS" +Peter Hutterer <[email protected]> + +.SH "SEE ALSO" +__xservername__(__appmansuffix__), wacom(__drivermansuffix__), +xorg.conf(__filemansuffix__), +X(__miscmansuffix__) -- 1.6.5.2 ------------------------------------------------------------------------------ _______________________________________________ Linuxwacom-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/linuxwacom-devel
