[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 27/28: groff(1), troff(1): Correct -I documentation.
From: |
G. Branden Robinson |
Subject: |
[groff] 27/28: groff(1), troff(1): Correct -I documentation. |
Date: |
Tue, 1 Sep 2020 07:43:12 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit e9d0f7297c887aa3271cf756c885182c1d3a2feb
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sun Aug 30 01:34:25 2020 +1000
groff(1), troff(1): Correct -I documentation.
The description of the -I was incomplete and in one aspect incorrect.
* The current working directory is searched _last_, not first, unless
the order is altered with "-I .".
* The option is both passed through to troff by groff and has additional
function. -I options are passed to soelim by groff.
* Add -I paragraph to "transparent" [sic] troff options subsection of
groff(1); abbreviate its description and move the detailed one to
troff(1).
* Explain the mnemonic of calling the option -I.
---
ChangeLog | 9 ++++++++
src/roff/groff/groff.1.man | 51 ++++++++++++++++++++++++----------------------
src/roff/troff/troff.1.man | 47 +++++++++++++++++++++++++++++-------------
3 files changed, 69 insertions(+), 38 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 8a57ef8..7adc5e5 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2020-08-30 G. Branden Robinson <g.branden.robinson@gmail.com>
+
+ * src/roff/troff/troff.1.man (Options) <-I>: The current working
+ directory is searched _last_, not first, unless the order is
+ altered with "-I .".
+
+ * src/roff/groff/groff.1.man (Options) <-I>: Rearrange
+ description.
+
2020-08-25 G. Branden Robinson <g.branden.robinson@gmail.com>
Update mdoc package to honor HY register as man does now, per
diff --git a/src/roff/groff/groff.1.man b/src/roff/groff/groff.1.man
index 3974409..57230dc 100644
--- a/src/roff/groff/groff.1.man
+++ b/src/roff/groff/groff.1.man
@@ -183,31 +183,17 @@ Implies
.
.
.TP
-.BI \-I\ dir
-This option may be used to specify a directory to search for
-files (both those on the command line and those named in
-.B .psbb
-and
-.B .so
-requests, and
-.B \eX'ps: import'
-,
-.B \eX'ps: file'
-and
-.B \eX'pdf: pdfpic'
-escapes).
-.
-The current directory is always searched first.
-.
-This option may be specified more than once;
-the directories are searched in the order specified.
-.
-No directory search is performed for files specified using an absolute
-path.
-.
-This option implies the
+.B \-I\~ dir
+Works as
+.IR @g@troff 's
+option
+(see below),
+but also implies
.B \-s
-option.
+and passes the
+.B \-I
+options to
+.IR soelim .
.
.
.TP
@@ -683,6 +669,23 @@ Set path for device
files.
.
.TP
+.BI \-I\~ dir
+Search
+.I dir
+for files
+(those on the command line,
+those named in
+.B .psbb
+and
+.B .so
+requests,
+and
+those named in certain device commands issued with the
+.B \[rs]X
+escape).
+.
+.
+.TP
.B \-i
Process standard input after the specified input files.
.
diff --git a/src/roff/troff/troff.1.man b/src/roff/troff/troff.1.man
index e414dcc..ae261a5 100644
--- a/src/roff/troff/troff.1.man
+++ b/src/roff/troff/troff.1.man
@@ -186,24 +186,43 @@ Read the standard input after all the named input files
have been
processed.
.
.TP
-.BI \-I dir
-This option may be used to add a directory to the search path for
-files (both those on the command line and those named in
-.B \&.psbb
-requests).
-.
-The search path is initialized with the current directory.
+.BI \-I\~ dir
+Search
+.I dir
+for files
+(those on the command line,
+those named in
+.B .psbb
+and
+.B .so
+requests,
+and
+those named in
+.RB \[lq] "\[rs]X\[aq]ps: import\[aq]" \[rq],
+.RB \[lq] "\[rs]X\[aq]ps: file\[aq]" \[rq],
+and
+.RB \[lq] "\[rs]X\[aq]pdf: pdfpic\[aq]" \[rq]
+escapes).
.
-This option may be specified more than once; the directories are then
-searched in the order specified (but before the current directory).
+This option may be specified more than once;
+the directories are then searched in the order specified.
.
-If you want to make the current directory be read before other
-directories, add
-.B \-I.\&
+If you want to search the current directory before others,
+add
+.RB \[lq] "\-I .\&" \[rq]
at the appropriate place.
.
-.IP
-No directory search is performed for files with an absolute file name.
+The current working directory is otherwise searched last.
+.
+.B \-I
+works similarly to,
+and is named for,
+the \[lq]include\[rq]
+option of Unix C compilers.
+.
+No directory search is performed for files specified using an absolute
+file name.
+.
.
.TP
.BI \-m name
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 27/28: groff(1), troff(1): Correct -I documentation.,
G. Branden Robinson <=