From: Sami Kerola <kerolasa@iki.fi>
Date: Sat, 24 May 2014 09:58:27 +0000 (+0100)
Subject: docs: setterm.1 add options compatibility note
X-Git-Tag: v2.25-rc1~87^2~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f0dcd918eb785388dd6f70b17d42024e75ec3b4d;p=thirdparty%2Futil-linux.git

docs: setterm.1 add options compatibility note

Both --option and -option formats are accepted.

Reviewed-by: Benno Schulenberg <bensberg@justemail.net>
Signed-off-by: Sami Kerola <kerolasa@iki.fi>
---

diff --git a/term-utils/setterm.1 b/term-utils/setterm.1
index cc69617e4d..eb4f00d16c 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),