TAG 0.22.1-2
[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 "November 24, 2012"
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 [ OPTIONS ]
23 [
24 .I text
25 |
26 .B \-
27 ]
28 .SH DESCRIPTION
29 .BR Screen\ Message 
30 will display a given multi-line message as large as
31 possible, fullscreen and black on white. You can specify the text either
32 when launching sm, or edit it while the program is running.
33 .PP
34 After a short timeout, the text entry and the quit button will disappear, leaving
35 nothing on the screen but the entered text. To continue entering text, just start
36 typing or (left-)click anywhere on the screen.
37 .PP
38 To clear the displayed text, press Escape.
39 .PP
40 To quit the program, press Ctrl-Q, or Escape twice, or click the "Quit"-button.
41 .br
42
43 .SH OPTIONS
44 .TP
45 [ \fItext\fR | \fB\-\fR ]
46 Text to display at start up. Defaults to ":-)". If "\fB\-\fR" is passed to sm,
47 it will read the text to display from the standard input, see \fBREMOTE CONTROLLING SM\fR.
48 .TP
49 .BI \-f,\ \-\-foreground= colordesc
50 Define a different color to use for the foreground of the text to
51 display than black. The text string can be in any of the forms accepted
52 by XParseColor; these include name for a color from rgb.txt, such as
53 DarkSlateGray, or a hex specification such as #3050b2 or #35b.
54 .TP
55 .BI \-b,\ \-\-background= colordesc
56 Define a different color to use for the background of the text to
57 display than white. For possible values, see above.
58 .TP
59 .BI \-n,\ \-\-font= fontspec
60 Define a different font to use than the default sans-serif font of your
61 system. The fontspec be the complete name for a truetype font (like
62 "DejaVu Sans" or "Bitstream Vera Serif") or just a short font family
63 specification ("serif", "sans-serif").
64 .TP
65 .BI \-r,\ \-\-rotate= rotation
66 Rotates the display by rotation*90 degrees counter-clock-wise. So \-r 1 
67 rotates the display to the left, and \-r 2 puts it upside down.
68 .TP
69 .BI \-a,\ \-\-align= alignment
70 Aligns the text centered (\-a 0), left (\-a 1) or right (\-a 2).
71 .TP
72 .BI \-\-
73 (Double dash) End option parsing. This is used to be able to actually hand over text
74 that starts of with an dash.
75 .TP
76 .BI \-h,\ \-\-help
77 This option will give you a short usage message summarizing the
78 recognized options and quits.
79 .TP
80 .BI \-V,\ \-\-version
81 This prints the project name together with its version number
82 quits.
83
84 .SH REMOTE CONTROLLING SM
85 If sm is called with \fB\-\fR as a command line argument, it will read the text to be
86 shown from the standard input. It will read the input until it reaches the end
87 of the file, or the line feed character \fB\\f\fR, and show the input read so far at
88 once. Newline characters at the beginning or the end are ignored. The input is assumed to be UTF-8 encoded 
89 .RB "(see " utf8 (7)).
90 .PP
91 This can be used to create automatic displays of changing data or similar tricks. For example, the following command will create a simple digital watch:
92 .sp
93 .B (while sleep 1; do date +%T; echo -e '\\\\f'; done) | sm -
94
95
96 .SH AUTHOR
97 This manual page was written by Joachim Breitner
98 <mail@joachim-breitner.de> and updated by Gerfried Fuchs <rhonda@deb.at>
99 to reflect additions for commandline option handling.