Ignore trailing newline from standard in
[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 After a short timeout, the text entry and the quit button will disappear, leaving
31 nothing on the screen but the entered text. To continue entering text, just start
32 typing or (left-)click anywhere on the screen.
33 .PP
34 To clear the displayed text, press Escape.
35 .PP
36 To quit the program, press Ctrl-Q or press the button.
37 .br
38
39 .SH OPTIONS
40 .TP
41 .RI [ text ]
42 Text to display at start up. Defaults to ":-)". If "\-" is passed to sm,
43 it will read the text to display from stdin.
44 .TP
45 .BI \-f,\ \-\-foreground= colordesc
46 Define a different color to use for the foreground of the text to
47 display than black. The text string can be in any of the forms accepted
48 by XParseColor; these include name for a color from rgb.txt, such as
49 DarkSlateGray, or a hex specification such as #3050b2 or #35b.
50 .TP
51 .BI \-b,\ \-\-background= colordesc
52 Define a different color to use for the background of the text to
53 display than white. For possible values, see above.
54 .TP
55 .BI \-n,\ \-\-font= fontspec
56 Define a different font to use than the default sans-serif font of your
57 system. The fontspec be the complete name for a truetype font (like
58 "DejaVu Sans" or "Bitstream Vera Serif") or just a short font family
59 specification ("serif", "sans-serif").
60 .TP
61 .BI \-r,\ \-\-rotate= rotation
62 Rotates the display by rotation*90 degrees counter-clock-wise. So \-r 1 
63 rotates the display to the left, and \-r 2 puts it upside down.
64 .TP
65 .BI \-\-
66 (Double dash) End option parsing. This is used to be able to actually hand over text
67 that starts of with an dash.
68 .TP
69 .BI \-h,\ \-\-help
70 This option will give you a short usage message summarizing the
71 recognized options and quits.
72 .TP
73 .BI \-V,\ \-\-version
74 This prints the project name together with its version number
75 quits.
76
77 .SH AUTHOR
78 This manual page was written by Joachim Breitner
79 <mail@joachim-breitner.de> and updated by Gerfried Fuchs <rhonda@deb.at>
80 to reflect additions for commandline option handling.