File: sm.6

package info (click to toggle)
screen-message 0.19-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 408 kB
  • ctags: 83
  • sloc: sh: 1,103; ansic: 288; python: 94; makefile: 43
file content (80 lines) | stat: -rw-r--r-- 2,930 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH SM 6 "August 05, 2008"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
sm \- Displays a short text fullscreen
.SH SYNOPSIS
.B sm
.RI [ OPTIONS ]
.RI [ text | \- ]
.SH DESCRIPTION
.BR Screen\ Message 
will display a given multi-line message as large as
possible, fullscreen and black on white. You can specify the text either
when launching sm, or edit it while the program is running.
.PP
After a short timeout, the text entry and the quit button will disappear, leaving
nothing on the screen but the entered text. To continue entering text, just start
typing or (left-)click anywhere on the screen.
.PP
To clear the displayed text, press Escape.
.PP
To quit the program, press Ctrl-Q or press the button.
.br

.SH OPTIONS
.TP
.RI [ text ]
Text to display at start up. Defaults to ":-)". If "\-" is passed to sm,
it will read the text to display from stdin.
.TP
.BI \-f,\ \-\-foreground= colordesc
Define a different color to use for the foreground of the text to
display than black. The text string can be in any of the forms accepted
by XParseColor; these include name for a color from rgb.txt, such as
DarkSlateGray, or a hex specification such as #3050b2 or #35b.
.TP
.BI \-b,\ \-\-background= colordesc
Define a different color to use for the background of the text to
display than white. For possible values, see above.
.TP
.BI \-n,\ \-\-font= fontspec
Define a different font to use than the default sans-serif font of your
system. The fontspec be the complete name for a truetype font (like
"DejaVu Sans" or "Bitstream Vera Serif") or just a short font family
specification ("serif", "sans-serif").
.TP
.BI \-r,\ \-\-rotate= rotation
Rotates the display by rotation*90 degrees counter-clock-wise. So \-r 1 
rotates the display to the left, and \-r 2 puts it upside down.
.TP
.BI \-\-
(Double dash) End option parsing. This is used to be able to actually hand over text
that starts of with an dash.
.TP
.BI \-h,\ \-\-help
This option will give you a short usage message summarizing the
recognized options and quits.
.TP
.BI \-V,\ \-\-version
This prints the project name together with its version number
quits.

.SH AUTHOR
This manual page was written by Joachim Breitner
<mail@joachim-breitner.de> and updated by Gerfried Fuchs <rhonda@deb.at>
to reflect additions for commandline option handling.