aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/roff.7
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2011-12-11 00:38:11 +0000
committerIngo Schwarze <schwarze@openbsd.org>2011-12-11 00:38:11 +0000
commit424e4a7f6dd613adba96e61c70ed0ad508fc1d45 (patch)
tree0da5009acea7b9b403809f696b95427e993c29d9 /roff.7
parente37a18a3101ea075803ef75ce48dd9f7051ad3e8 (diff)
downloadmandoc-424e4a7f6dd613adba96e61c70ed0ad508fc1d45.tar.gz
mandoc-424e4a7f6dd613adba96e61c70ed0ad508fc1d45.tar.zst
mandoc-424e4a7f6dd613adba96e61c70ed0ad508fc1d45.zip
Explain where .so paths are rooted, and why, and discourage its use;
feedback and ok jmc@, suggested by and ok kristaps@.
Diffstat (limited to 'roff.7')
-rw-r--r--roff.720
1 files changed, 18 insertions, 2 deletions
diff --git a/roff.7 b/roff.7
index 78185f9d..dd32a45b 100644
--- a/roff.7
+++ b/roff.7
@@ -1,4 +1,4 @@
-.\" $Id: roff.7,v 1.36 2011/11/23 02:12:24 schwarze Exp $
+.\" $Id: roff.7,v 1.37 2011/12/11 00:38:11 schwarze Exp $
.\"
.\" Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\" Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org>
@@ -15,7 +15,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: November 23 2011 $
+.Dd $Mdocdate: December 11 2011 $
.Dt ROFF 7
.Os
.Sh NAME
@@ -844,6 +844,22 @@ only accepts relative paths not containing the strings
.Qq ../
and
.Qq /.. .
+.Pp
+This request requires
+.Xr man 1
+to change to the right directory before calling
+.Xr mandoc 1 ,
+per convention to the root of the manual tree.
+Typical usage looks like:
+.Pp
+.Dl \&.so man3/Xcursor.3
+.Pp
+As the whole concept is rather fragile, the use of
+.Sx \&so
+is discouraged.
+Use
+.Xr ln 1
+instead.
.Ss \&ta
Set tab stops.
This line-scoped request can take an arbitrary number of arguments.