From 60cd11cf0b83176e7c542e51a7e6a3eaea58401c Mon Sep 17 00:00:00 2001 From: Gaetan Nadon Date: Wed, 19 Jan 2011 10:06:55 -0500 Subject: config: move man pages into their own directory Use services provided by XORG_MANPAGE_SECTIONS. Use standard Makefile for man pages. Signed-off-by: Gaetan Nadon --- Makefile.am | 20 +------- configure.ac | 5 +- man/Makefile.am | 14 ++++++ man/setxkbmap.man | 139 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ setxkbmap.man | 139 ------------------------------------------------------ 5 files changed, 158 insertions(+), 159 deletions(-) create mode 100644 man/Makefile.am create mode 100644 man/setxkbmap.man delete mode 100644 setxkbmap.man diff --git a/Makefile.am b/Makefile.am index a292290..08ffbb1 100644 --- a/Makefile.am +++ b/Makefile.am @@ -19,6 +19,7 @@ # TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR # PERFORMANCE OF THIS SOFTWARE. +SUBDIRS = man bin_PROGRAMS = setxkbmap XKBCONFIGROOT=@XKBCONFIGROOT@ @@ -30,16 +31,7 @@ setxkbmap_LDADD = $(SETXKBMAP_LIBS) setxkbmap_SOURCES = \ setxkbmap.c -appman_PRE = \ - setxkbmap.man - -appmandir = $(APP_MAN_DIR) - -appman_DATA = $(appman_PRE:man=@APP_MAN_SUFFIX@) - -EXTRA_DIST = $(appman_PRE) MAINTAINERCLEANFILES = ChangeLog INSTALL -CLEANFILES = $(appman_DATA) .PHONY: ChangeLog INSTALL @@ -51,16 +43,6 @@ ChangeLog: dist-hook: ChangeLog INSTALL -# String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure -setxkbmap_MAN_SUBSTS = \ - -e 's|__xkbconfigroot__|"$(XKBCONFIGROOT)"|' \ - $(MAN_SUBSTS) - -SUFFIXES = .$(APP_MAN_SUFFIX) .man - -.man.$(APP_MAN_SUFFIX): - $(AM_V_GEN)$(SED) $(setxkbmap_MAN_SUBSTS) < $< > $@ - if LINT ALL_LINT_FLAGS=$(LINT_FLAGS) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) \ $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) diff --git a/configure.ac b/configure.ac index d74db03..bc16554 100644 --- a/configure.ac +++ b/configure.ac @@ -51,4 +51,7 @@ PKG_CHECK_MODULES(SETXKBMAP, xkbfile x11) # Allow checking code with lint, sparse, etc. XORG_WITH_LINT -AC_OUTPUT([Makefile]) +AC_CONFIG_FILES([ + Makefile + man/Makefile]) +AC_OUTPUT diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 0000000..2d33de6 --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1,14 @@ + +appmandir = $(APP_MAN_DIR) +appman_PRE = setxkbmap.man +appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX)) + +EXTRA_DIST = $(appman_PRE) +CLEANFILES = $(appman_DATA) +SUFFIXES = .$(APP_MAN_SUFFIX) .man + +# String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure +MAN_SUBSTS += -e 's|__xkbconfigroot__|"$(XKBCONFIGROOT)"|' + +.man.$(APP_MAN_SUFFIX): + $(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@ diff --git a/man/setxkbmap.man b/man/setxkbmap.man new file mode 100644 index 0000000..1c0b87a --- /dev/null +++ b/man/setxkbmap.man @@ -0,0 +1,139 @@ +.\" +.TH SETXKBMAP __appmansuffix__ __xorgversion__ +.SH NAME +setxkbmap +\- set the keyboard using the X Keyboard Extension +.SH SYNOPSIS +.B setxkbmap [ +.I args +.B ] [ +.I layout +.B [ +.I variant +.B [ +.I option ... +.B ] ] ] +.SH DESCRIPTION +The +.B setxkbmap +command maps the keyboard to use the layout determined by the options +specified on the command line. +.P +An XKB keymap is constructed from a number of components which are compiled +only as needed. The source for all of the components can be found in +.IR __xkbconfigroot__ . +.SH OPTIONS +.TP 8 +.B \-help +Prints a message describing the valid input to \fIsetxkbmap\fP. +.TP 8 +.B \-compat \fIname\fP +Specifies the name of the compatibility map component used to construct +a keyboard layout. +.TP 8 +.B \-config \fIfile\fP +Specifies the name of an XKB configuration file which describes the +keyboard to be used. +.TP 8 +.B \-device \fIdevice\fP +Specifies the numeric device id of the input device to be updated with +the new keyboard layout. If not specified, the core keyboard device of +the X server is updated. +.TP 8 +.B \-display \fIdisplay\fP +Specifies the display to be updated with the new keyboard layout. +.TP 8 +.B \-geometry \fIname\fP +Specifies the name of the geometry component used to construct +a keyboard layout. +.TP 8 +.B \-I \fIdirectory\fP +Adds a directory to the list of directories to be used to search for +specified layout or rules files. +.TP 8 +.B \-keycodes \fIname\fP +Specifies the name of the keycodes component used to construct +a keyboard layout. +.TP 8 +.B \-keymap \fIname\fP +Specifies the name of the keymap description used to construct +a keyboard layout. +.TP 8 +.B \-layout \fIname\fP +Specifies the name of the layout used to determine the components which +make up the keyboard description. Only one layout may be specified on +the command line. +.TP 8 +.B \-model \fIname\fP +Specifies the name of the keyboard model used to determine the components +which make up the keyboard description. Only one model may be specified +on the command line. +.TP 8 +.B \-option \fIname\fP +Specifies the name of an option to determine the components which make up +the keyboard description; multiple options may be specified, one per +\fI-option\fP flag. Note that +.B setxkbmap +adds options specified in the command line to the options that were set +before (as saved in root window properties). If you want to replace all +previously specified options, use the \fI-option\fP flag with an empty +argument first. +.TP 8 +.B \-print +With this option \fBsetxkbmap\fP just prints component names in a format +acceptable by \fBxkbcomp\fP (an XKB keymap compiler) and exits. The option +can be used for tests instead of a verbose option and in cases when one needs +to run both the \fBsetxkbmap\fP and the \fBxkbcomp\fP in chain (see below). +.TP 8 +.B \-query +With this option \fBsetxkbmap\fP just prints the current rules, model, +layout, variant, and options, then exits. +.TP 8 +.B \-rules \fIfile\fP +Specifies the name of the rules file used to resolve the requested layout +and model to a set of component names. +.TP 8 +.B \-symbols \fIname\fP +Specifies the name of the symbols component used to construct +a keyboard layout. +.TP 8 +.B \-synch +Force synchronization for X requests. +.TP 8 +.B \-types \fIname\fP +Specifies the name of the types component used to construct +a keyboard layout. +.TP 8 +.B \-variant \fIname\fP +Specifies which variant of the keyboard layout should be used to determine +the components which make up the keyboard description. Only one variant +may be specified on the command line. +.TP 8 +.B \-verbose|\-v [\fIlevel\fP] +Specifies level of verbosity in output messages. Valid levels range from +0 (least verbose) to 10 (most verbose). The default verbosity level is 5. +If no level is specified, each \fI-v\fP or \fI-verbose\fP flag raises the +level by 1. +.SH USING WITH xkbcomp +If you have an Xserver and a client shell running on different computers and +XKB configuration files on those machines are different you can get +problems specifying a keyboard map by model, layout, options names. +This is because \fBsetxkbcomp\fP converts these names to names of XKB +configuration files according to files that are on the client side computer, +then it sends the file names to the server where the \fBxkbcomp\fP has to +compose a complete keyboard map using files which the server has. +Thus if the sets of files differ significantly the names that the +\fBsetxkbmap\fP generates can be unacceptable on the server side. You can +solve this problem by running the \fBxkbcomp\fP on the client side too. +With the \fI-print\fP option \fBsetxkbmap\fP just prints the file names +in an appropriate format to its stdout and this output can be piped +directly to the \fBxkbcomp\fP input. For example, the command + +\fBsetxkbmap us -print | xkbcomp - $DISPLAY\fP + +makes both steps run on the same (client) machine and loads a keyboard map into +the server. +.SH SEE ALSO +xkbcomp(__appmansuffix__) +.SH FILES +.I __xkbconfigroot__ diff --git a/setxkbmap.man b/setxkbmap.man deleted file mode 100644 index 1c0b87a..0000000 --- a/setxkbmap.man +++ /dev/null @@ -1,139 +0,0 @@ -.\" -.TH SETXKBMAP __appmansuffix__ __xorgversion__ -.SH NAME -setxkbmap -\- set the keyboard using the X Keyboard Extension -.SH SYNOPSIS -.B setxkbmap [ -.I args -.B ] [ -.I layout -.B [ -.I variant -.B [ -.I option ... -.B ] ] ] -.SH DESCRIPTION -The -.B setxkbmap -command maps the keyboard to use the layout determined by the options -specified on the command line. -.P -An XKB keymap is constructed from a number of components which are compiled -only as needed. The source for all of the components can be found in -.IR __xkbconfigroot__ . -.SH OPTIONS -.TP 8 -.B \-help -Prints a message describing the valid input to \fIsetxkbmap\fP. -.TP 8 -.B \-compat \fIname\fP -Specifies the name of the compatibility map component used to construct -a keyboard layout. -.TP 8 -.B \-config \fIfile\fP -Specifies the name of an XKB configuration file which describes the -keyboard to be used. -.TP 8 -.B \-device \fIdevice\fP -Specifies the numeric device id of the input device to be updated with -the new keyboard layout. If not specified, the core keyboard device of -the X server is updated. -.TP 8 -.B \-display \fIdisplay\fP -Specifies the display to be updated with the new keyboard layout. -.TP 8 -.B \-geometry \fIname\fP -Specifies the name of the geometry component used to construct -a keyboard layout. -.TP 8 -.B \-I \fIdirectory\fP -Adds a directory to the list of directories to be used to search for -specified layout or rules files. -.TP 8 -.B \-keycodes \fIname\fP -Specifies the name of the keycodes component used to construct -a keyboard layout. -.TP 8 -.B \-keymap \fIname\fP -Specifies the name of the keymap description used to construct -a keyboard layout. -.TP 8 -.B \-layout \fIname\fP -Specifies the name of the layout used to determine the components which -make up the keyboard description. Only one layout may be specified on -the command line. -.TP 8 -.B \-model \fIname\fP -Specifies the name of the keyboard model used to determine the components -which make up the keyboard description. Only one model may be specified -on the command line. -.TP 8 -.B \-option \fIname\fP -Specifies the name of an option to determine the components which make up -the keyboard description; multiple options may be specified, one per -\fI-option\fP flag. Note that -.B setxkbmap -adds options specified in the command line to the options that were set -before (as saved in root window properties). If you want to replace all -previously specified options, use the \fI-option\fP flag with an empty -argument first. -.TP 8 -.B \-print -With this option \fBsetxkbmap\fP just prints component names in a format -acceptable by \fBxkbcomp\fP (an XKB keymap compiler) and exits. The option -can be used for tests instead of a verbose option and in cases when one needs -to run both the \fBsetxkbmap\fP and the \fBxkbcomp\fP in chain (see below). -.TP 8 -.B \-query -With this option \fBsetxkbmap\fP just prints the current rules, model, -layout, variant, and options, then exits. -.TP 8 -.B \-rules \fIfile\fP -Specifies the name of the rules file used to resolve the requested layout -and model to a set of component names. -.TP 8 -.B \-symbols \fIname\fP -Specifies the name of the symbols component used to construct -a keyboard layout. -.TP 8 -.B \-synch -Force synchronization for X requests. -.TP 8 -.B \-types \fIname\fP -Specifies the name of the types component used to construct -a keyboard layout. -.TP 8 -.B \-variant \fIname\fP -Specifies which variant of the keyboard layout should be used to determine -the components which make up the keyboard description. Only one variant -may be specified on the command line. -.TP 8 -.B \-verbose|\-v [\fIlevel\fP] -Specifies level of verbosity in output messages. Valid levels range from -0 (least verbose) to 10 (most verbose). The default verbosity level is 5. -If no level is specified, each \fI-v\fP or \fI-verbose\fP flag raises the -level by 1. -.SH USING WITH xkbcomp -If you have an Xserver and a client shell running on different computers and -XKB configuration files on those machines are different you can get -problems specifying a keyboard map by model, layout, options names. -This is because \fBsetxkbcomp\fP converts these names to names of XKB -configuration files according to files that are on the client side computer, -then it sends the file names to the server where the \fBxkbcomp\fP has to -compose a complete keyboard map using files which the server has. -Thus if the sets of files differ significantly the names that the -\fBsetxkbmap\fP generates can be unacceptable on the server side. You can -solve this problem by running the \fBxkbcomp\fP on the client side too. -With the \fI-print\fP option \fBsetxkbmap\fP just prints the file names -in an appropriate format to its stdout and this output can be piped -directly to the \fBxkbcomp\fP input. For example, the command - -\fBsetxkbmap us -print | xkbcomp - $DISPLAY\fP - -makes both steps run on the same (client) machine and loads a keyboard map into -the server. -.SH SEE ALSO -xkbcomp(__appmansuffix__) -.SH FILES -.I __xkbconfigroot__ -- cgit v1.2.3