New resource and commandline option 'font' to specify an additional font.
[unicode-screensaver.git] / unicode.6x.in
1 .TH unicode-screensaver 6x "Version @version@" "X Version 11" "unicode-screensaver manual"
2 .SH NAME
3 unicode - displays unicode characters
4 .SH SYNOPSIS
5 .B unicode
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-fps]
11 [\-delay \fIseconds\fP]
12 [\-font \fIfont\fP]
13 [\-foreground \fIcolor\fP]
14 [\-background \fIcolor\fP]
15 .SH DESCRIPTION
16 unicode-screensaver is a simple screensaver application that repeatedly
17 randomly picks an unicode character and displays it in a very large font
18 size together with its unicode code point and the character name.
19 .SH OPTIONS
20 .TP 8
21 .B \-visual \fIvisual\fP
22 Specify which visual to use.  Legal values are the name of a visual class,
23 or the id number (decimal or hex) of a specific visual.
24 .TP 8
25 .B \-window
26 Draw on a newly-created window.  This is the default.
27 .TP 8
28 .B \-root
29 Draw on the root window.
30 .TP 8
31 .B \-fps
32 Display the current frame rate and CPU load.
33 .TP 8
34 .B \-delay
35 Specify the delay in seconds before switching to a new character. Defaults to
36 seven seconds.
37 .TP 8
38 .B \-font
39 Try the given font in addition to the built-in fonts (Open Symbol, and FreeSans).
40 .TP 8
41 .B \-background
42 Set the background color (e.g. black, white, green, red). The default is
43 white.
44 .TP 8
45 .B \-foreground
46 Set the font color (e.g. black, white, green, red). The default is black.
47 .SH ENVIRONMENT
48 .PP
49 .TP 8
50 .B DISPLAY
51 to get the default host and display number.
52 .TP 8
53 .B XENVIRONMENT
54 to get the name of a resource file that overrides the global resources
55 stored in the RESOURCE_MANAGER property.
56 .SH SEE ALSO
57 .BR X (1),
58 .BR xscreensaver (1)
59 .SH COPYRIGHT
60 Copyright \(co 2009 by Joachim Breitner.  Permission to use, copy, modify, 
61 distribute, and sell this software and its documentation for any purpose is 
62 hereby granted without fee, provided that the above copyright notice appear 
63 in all copies and that both that copyright notice and this permission notice
64 appear in supporting documentation.  No representations are made about the 
65 suitability of this software for any purpose.  It is provided "as is" without
66 express or implied warranty.
67 .SH AUTHOR
68 Joachim Breitner