summaryrefslogtreecommitdiff
path: root/share/man/man7
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@cvs.openbsd.org>2011-12-11 00:38:09 +0000
committerIngo Schwarze <schwarze@cvs.openbsd.org>2011-12-11 00:38:09 +0000
commitbfb9c87d7b3f5b12387b38452c8141fb8058f21f (patch)
tree3d0152e90adacf02742fa893c93b3b1396d20c5c /share/man/man7
parent4fd832da65e4abdcb67096960cfe64be43f7d304 (diff)
Explain where .so paths are rooted, and why, and discourage its use;
feedback and ok jmc@, suggested by and ok kristaps@.
Diffstat (limited to 'share/man/man7')
-rw-r--r--share/man/man7/roff.720
1 files changed, 18 insertions, 2 deletions
diff --git a/share/man/man7/roff.7 b/share/man/man7/roff.7
index bd0040c5b6c..c295288efed 100644
--- a/share/man/man7/roff.7
+++ b/share/man/man7/roff.7
@@ -1,4 +1,4 @@
-.\" $OpenBSD: roff.7,v 1.17 2011/11/23 02:12:22 schwarze Exp $
+.\" $OpenBSD: roff.7,v 1.18 2011/12/11 00:38:08 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
@@ -870,6 +870,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.