Changelog for Rhondas changes
[darcs-mirror-screen-message.debian.git] / sm.6
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH SM 6 "August 05, 2008"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh        disable hyphenation
10 .\" .hy        enable hyphenation
11 .\" .ad l      left justify
12 .\" .ad b      justify to both left and right margins
13 .\" .nf        disable filling
14 .\" .fi        enable filling
15 .\" .br        insert line break
16 .\" .sp <n>    insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 sm \- Displays a short text fullscreen
20 .SH SYNOPSIS
21 .B sm
22 .RI [ OPTIONS ]
23 .RI [ text | \- ]
24 .SH DESCRIPTION
25 .BR Screen\ Message 
26 will display a given multi-line message as large as
27 possible, fullscreen and black on white. You can specify the text either
28 when launching sm, or edit it while the program is running.
29 .PP
30 To clear the displayed text, press Escape.
31 .PP
32 To quit the program, press Ctrl-Q or press the button.
33 .br
34
35 .SH OPTIONS
36 .TP
37 .RI [ text ]
38 Text to display at start up. Defaults to ":-)". If "\-" is passed to sm,
39 it will read the text to display from stdin.
40 .TP
41 .BI \-f,\ \-\-foreground= colordesc
42 Define a different color to use for the foreground of the text to
43 display than black. The text string can be in any of the forms accepted
44 by XParseColor; these include name for a color from rgb.txt, such as
45 DarkSlateGray, or a hex specification such as #3050b2 or #35b.
46 .TP
47 .BI \-b,\ \-\-background= colordesc
48 Define a different color to use for the background of the text to
49 display than white. For possible values, see above.
50 .TP
51 .BI \-n,\ \-\-font= fontspec
52 Define a different font to use than the default sans-serif font of your
53 system. The fontspec be the complete name for a truetype font (like
54 "DejaVu Sans" or "Bitstream Vera Serif") or just a short font family
55 specification ("serif", "sans-serif").
56 .TP
57 .BI \-\-
58 (Double dash) End option parsing. This is used to be able to actually hand over text
59 that starts of with an dash.
60 .TP
61 .BI \-h,\ \-\-help
62 This option will give you a short usage message summarizing the
63 recognized options and quits.
64 .TP
65 .BI \-V,\ \-\-version
66 This prints the project name together with its version number
67 quits.
68
69 .SH AUTHOR
70 This manual page was written by Joachim Breitner
71 <mail@joachim-breitner.de> and updated by Gerfried Fuchs <rhonda@deb.at>
72 to reflect additions for commandline option handling.