From 3e74d8d780e87ebb31acfcf8a4b693bd7c035cab Mon Sep 17 00:00:00 2001 From: rhonda Date: Tue, 5 Aug 2008 21:32:35 +0000 Subject: [PATCH] The patch manpage-options-explained adds option handling to manual page. --- sm.6 | 39 +++++++++++++++++++++++++++++++++++---- 1 file changed, 35 insertions(+), 4 deletions(-) diff --git a/sm.6 b/sm.6 index f4878b9..dce9b0a 100644 --- 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) -.TH SM 6 "June 14, 2007" +.TH SM 6 "August 05, 2008" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: @@ -19,7 +19,8 @@ sm \- Displays a short text fullscreen .SH SYNOPSIS .B sm -.RI [ text | - ] +.RI [ OPTIONS ] +.RI [ text | \- ] .SH DESCRIPTION .BR Screen\ Message will display a given multi-line message as large as @@ -34,8 +35,38 @@ To quit the program, press Ctrl-Q or press the button. .SH OPTIONS .TP .RI [ text ] -Text to display at start up. Defaults to ":-)". If "-" is passed to sm, +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 \-\- +(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 . +This manual page was written by Joachim Breitner + and updated by Gerfried Fuchs +to reflect additions for commandline option handling. -- 2.20.1