xkbprint/xkbprint.man

   1 .\" $Xorg: xkbprint.man,v 1.3 2000/08/17 19:54:50 cpqbld Exp $
   2 .\"
   3 .\" $XFree86: xc/programs/xkbprint/xkbprint.man,v 1.7 2001/01/27 18:21:16 dawes Exp $
   4 .\"
   5 .TH XKBPRINT 1 __xorgversion__
   6 .SH NAME
   7 xkbprint \- print an XKB keyboard description
   8 .SH SYNOPSIS
   9 .B xkbprint
  10 [options] source [ output_file ]
  11 .SH DESCRIPTION
  12 .PP
  13 The
  14 .I xkbprint
  15 command generates a printable or encapsulated PostScript description of the
  16 XKB keyboard description specified by \fIsource\fP.  The \fIsource\fP can be
  17 any compiled keymap (.xkm) file that includes a geometry description or an
  18 X display specification.  If an \fIoutput_file\fP is specified, xkbprint
  19 writes to it.  If no output file is specified, xkbprint creates replaces
  20 the extension of the source file with \fI.ps\fP or \fI.eps\fP depending
  21 on the requested format.  If the source is a non-local X display (e.g.:0),
  22 xkbprint appends the appropriate prefix to the display specification,
  23 replacing the colon with a dash.  For a local display, xkprint uses
  24 server-\fIn\fP where \fIn\fP is the number of the display.
  25 .SH OPTIONS
  26 .TP 8
  27 .B \-?, -help
  28 Prints a usage message.
  29 .TP 8
  30 .B \-color
  31 Print using the colors specified in the geometry file;  by default, xkbprint
  32 prints a black-and-white image of the keyboard.
  33 .TP 8
  34 .B \-dflts
  35 Attempt to compute default names for any missing components, such as keys.
  36 .TP 8
  37 .B \-diffs
  38 Show symbols only where they are explicitly bound.
  39 .TP 8
  40 .B \-eps
  41 Generate an encapsulated PostScript file.
  42 .TP 8
  43 .B \-fit
  44 Fit the keyboard image on the page (default).
  45 .TP 8
  46 .B \-full
  47 Print the keyboard at full size.
  48 .TP 8
  49 .B \-grid\ \fIres\fP
  50 Print a grid with \fIres\fPmm resolution over the keyboard.
  51 .TP 8
  52 .B \-if\ \fIfontName\fP
  53 Specifies an internal PostScript type 1 font to dump to the specified
  54 output file or to \fIfontName\fP.pfa, if no output file is specified.
  55 No keyboard description is printed if an internal font is dumped.
  56 .TP 8
  57 .B \-label\ \fItype\fP
  58 Specifies the labels to be printed on keys;  legal types are: \fInone\fP,
  59 \fIname\fP,\fIcode\fP,\fIsymbols\fP.
  60 .TP 8
  61 .B \-lc\ \fI<locale>\fP
  62 Specifies a locale in which KeySyms should be resolved.
  63 .TP 8
  64 .B \-level1
  65 Generate level 1 PostScript.
  66 .TP 8
  67 .B \-level2
  68 Generate level 2 PostScript.
  69 .TP 8
  70 .B \-lg\ \fIgroup\fP
  71 Print symbols in keyboard groups starting from \fIgroup\fP.
  72 .TP 8
  73 .B \-ll\ \fIlevel\fP
  74 Print symbols starting from shift level \fIlevel\fP.
  75 .TP 8
  76 .B \-mono
  77 Generate black-and-white image of keyboard (default).
  78 .TP 8
  79 .B \-n\ \fInum\fP
  80 Print \fInum\fP copies.
  81 .TP 8
  82 .B \-nkg\ \fInum\fP
  83 Print the symbols in \fInum\fP keyboard groups.
  84 .TP 8
  85 .B \-npk\ \fInum\fP
  86 Number of keyboard images to print on each page; for EPS files, this
  87 specifies the total number of keyboard images to print.
  88 .TP 8
  89 .B \-o\ \fIfile\fP
  90 Write output to \fIfile\fP.
  91 .TP 8
  92 .B \-R\fIdirectory\fP
  93 Use \fIdirectory\fP as the root directory; all path names are interpreted
  94 relative to \fIdirectory\fP.
  95 .TP 8
  96 .B -pict \fIwhich\fP
  97 Controls use of pictographs instead of keysym names where available.
  98 \fIwhich\fP can be any of \fIall\fP, \fInone\fP, or \fIcommon\fP(default).
  99 .TP 8
 100 .B -synch
 101 Forces synchronization for X requests.
 102 .TP 8
 103 .B -w\ \fIlevel\fP
 104 Sets warning level (0 for no warning, 10 for all warnings).
 105 .SH "SEE ALSO"
 106 X(__miscmansuffix__),xkbcomp(1)
 107 .SH COPYRIGHT
 108 Copyright 1995, Silicon Graphics Computer Systems
 109 Copyright 1995, 1998  The Open Group
 110 .br
 111 See \fIX(__miscmansuffix__)\fP for a full statement of rights and permissions.
 112 .SH AUTHOR
 113 Erik Fortune, Silicon Graphics