From a36e8abccc5db38e4d2f8ea2bbb3e78dfddacd78 Mon Sep 17 00:00:00 2001
From: Assaf Gordon <assafgordon@gmail.com>
Date: Fri, 24 Feb 2017 01:18:28 -0500
Subject: doc: warn against misuse of -i with other options

'sed -iE' is not the same as 'sed -Ei'. 'sed -ni' is dangerous.
From https://bugs.debian.org/832088

* doc/sed.texi (Command-Line Options): Explain and add examples
to '-i/--in-place' item.
---
 doc/sed.texi | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

(limited to 'doc')

diff --git a/doc/sed.texi b/doc/sed.texi
index 6b272ee..92bff01 100644
--- a/doc/sed.texi
+++ b/doc/sed.texi
@@ -307,6 +307,31 @@ directory (provided the directory already exists).
 If no extension is supplied, the original file is
 overwritten without making a backup.
 
+Because @option{-i} takes an optional argument, it should
+not be followed by other short options:
+@table @code
+@item sed -Ei '...' FILE
+Same as @option{-E -i} with no backup suffix - @file{FILE} will be
+edited in-place without creating a backup.
+
+@item sed -iE '...' FILE
+This is equivalent to @option{--in-place=E}, creating @file{FILEE} as backup
+of @file{FILE}
+@end table
+
+Be cautious of using @option{-n} with @option{-i}: the former disables
+automatic printing of lines and the latter changes the file in-place
+without a backup. Used carelessly (and without an explicit @code{p} command),
+the output file will be empty:
+@codequotebacktick on
+@codequoteundirected on
+@example
+# WRONG USAGE: 'FILE' will be truncated.
+sed -ni 's/foo/bar/' FILE
+@end example
+@codequotebacktick off
+@codequoteundirected off
+
 @item -l @var{N}
 @itemx --line-length=@var{N}
 @opindex -l
-- 
cgit v1.2.1