New parameter: --align
[darcs-mirror-screen-message.debian.git] / sm.6
diff --git a/sm.6 b/sm.6
index 667467f..6a344b1 100644 (file)
--- a/sm.6
+++ b/sm.6
@@ -2,7 +2,7 @@
 .\" 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)
 .\" 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"
+.TH SM 6 "November 24, 2012"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .\" Some roff macros, for reference:
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .\" Some roff macros, for reference:
 sm \- Displays a short text fullscreen
 .SH SYNOPSIS
 .B sm
 sm \- Displays a short text fullscreen
 .SH SYNOPSIS
 .B sm
-.RI [ OPTIONS ]
-.RI [ text | \- ]
+[ OPTIONS ]
+[
+.I text
+|
+.B \-
+]
 .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
 .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 clear the displayed text, press Escape.
 .PP
-To quit the program, press Ctrl-Q or press the button.
+To quit the program, press Ctrl-Q, or Escape twice, or click the "Quit"-button.
 .br
 
 .SH OPTIONS
 .TP
 .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.
+[ \fItext\fR | \fB\-\fR ]
+Text to display at start up. Defaults to ":-)". If "\fB\-\fR" is passed to sm,
+it will read the text to display from the standard input, see \fBREMOTE CONTROLLING SM\fR.
 .TP
 .BI \-f,\ \-\-foreground= colordesc
 Define a different color to use for the foreground of the text to
 .TP
 .BI \-f,\ \-\-foreground= colordesc
 Define a different color to use for the foreground of the text to
@@ -58,6 +66,9 @@ specification ("serif", "sans-serif").
 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
 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 \-a,\ \-\-align= alignment
+Aligns the text centered (\-a 0), left (\-a 1) or right (\-a 2).
+.TP
 .BI \-\-
 (Double dash) End option parsing. This is used to be able to actually hand over text
 that starts of with an dash.
 .BI \-\-
 (Double dash) End option parsing. This is used to be able to actually hand over text
 that starts of with an dash.
@@ -70,6 +81,18 @@ recognized options and quits.
 This prints the project name together with its version number
 quits.
 
 This prints the project name together with its version number
 quits.
 
+.SH REMOTE CONTROLLING SM
+If sm is called with \fB\-\fR as a command line argument, it will read the text to be
+shown from the standard input. It will read the input until it reaches the end
+of the file, or the line feed character \fB\\f\fR, and show the input read so far at
+once. Newline characters at the beginning or the end are ignored. The input is assumed to be UTF-8 encoded 
+.RB "(see " utf8 (7)).
+.PP
+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:
+.sp
+.B (while sleep 1; do date +%T; echo -e '\\\\f'; done) | sm -
+
+
 .SH AUTHOR
 This manual page was written by Joachim Breitner
 <mail@joachim-breitner.de> and updated by Gerfried Fuchs <rhonda@deb.at>
 .SH AUTHOR
 This manual page was written by Joachim Breitner
 <mail@joachim-breitner.de> and updated by Gerfried Fuchs <rhonda@deb.at>