From f0dcd918eb785388dd6f70b17d42024e75ec3b4d Mon Sep 17 00:00:00 2001 From: Sami Kerola Date: Sat, 24 May 2014 10:58:27 +0100 Subject: docs: setterm.1 add options compatibility note Both --option and -option formats are accepted. Reviewed-by: Benno Schulenberg Signed-off-by: Sami Kerola --- term-utils/setterm.1 | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'term-utils') diff --git a/term-utils/setterm.1 b/term-utils/setterm.1 index cc69617e4..eb4f00d16 100644 --- a/term-utils/setterm.1 +++ b/term-utils/setterm.1 @@ -8,7 +8,7 @@ .\" Undocumented: -snow, -softscroll, -standout; these are .\" commented out in the source .\" -.TH SETTERM 1 "January 2000" "util-linux" "User Commands" +.TH SETTERM 1 "May 2014" "util-linux" "User Commands" .SH NAME setterm \- set terminal attributes .SH SYNOPSIS @@ -196,6 +196,16 @@ Display version information and exit. .TP .BR \-\-help Display help text and exit. +.SH COMPATIBILITY +Since version 2.25 the +.B setterm +has support for long options with two hyphens, for example +.BR \-\-help , +beside the historical long options with a single hyphen, for example +.BR \-help . +In scripts it is better to use the backward compatible single hyphen +rather than the double hyphen. Currently there are no plans or good +reasons to discontinue single hyphen compatibility. .SH "SEE ALSO" .BR tput (1), .BR stty (1), -- cgit v1.2.3-55-g7522