Source-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[src/trunk]: src Edit -mdoc usage.
details: https://anonhg.NetBSD.org/src/rev/90dae421d82b
branches: trunk
changeset: 521856:90dae421d82b
user: ross <ross%NetBSD.org@localhost>
date: Thu Feb 07 03:15:06 2002 +0000
description:
Edit -mdoc usage.
* There is no -indent option to .Bd or .Bl, although you would
never know that from its frequent use in this tree. There is a
"-offset indent" combination that makes sense, and you can certainly
say "-width indent".
* Also, you can't markup the -width option argument, tho you CAN
use a callable macro. So "-width Ar filename" doesn't make sense,
but either "-width Ar" or "-width filename" does, as might something
like "-width xxfilename" for a little extra space.
* There are a lot of needlessly complex hanging tag macros in man4 used
to create simple item lists. Those should be simplified one of these
days before someone copies and edits yet another man4 page.
diffstat:
dist/bind/man/host.1 | 6 +++---
lib/libc/gen/sysctl.3 | 32 ++++++++++++++++----------------
libexec/ld.aout_so/ld.aout_so.1 | 6 +++---
sbin/fsck_ext2fs/fsck_ext2fs.8 | 10 +++++-----
sbin/fsck_ffs/fsck_ffs.8 | 10 +++++-----
sbin/fsck_lfs/fsck_lfs.8 | 10 +++++-----
share/man/man4/agp.4 | 4 ++--
share/man/man4/aha.4 | 4 ++--
share/man/man4/ahb.4 | 4 ++--
share/man/man4/ai.4 | 4 ++--
share/man/man4/aue.4 | 4 ++--
share/man/man4/bha.4 | 4 ++--
share/man/man4/bpf.4 | 24 ++++++++++++------------
share/man/man4/cac.4 | 4 ++--
share/man/man4/cue.4 | 4 ++--
share/man/man4/dpt.4 | 4 ++--
share/man/man4/intersil7170.4 | 4 ++--
share/man/man4/kue.4 | 4 ++--
share/man/man4/le.4 | 10 +++++-----
share/man/man4/man4.amiga/fdc.4 | 4 ++--
share/man/man4/man4.arm32/eh.4 | 4 ++--
share/man/man4/man4.arm32/em.4 | 4 ++--
share/man/man4/man4.arm32/ie.4 | 4 ++--
share/man/man4/man4.i386/busmouse.4 | 4 ++--
share/man/man4/man4.i386/fdc.4 | 4 ++--
share/man/man4/man4.vax/uda.4 | 4 ++--
share/man/man4/mk48txx.4 | 6 +++---
share/man/man4/mlx.4 | 4 ++--
share/man/man4/pss.4 | 4 ++--
share/man/man4/puc.4 | 6 +++---
share/man/man4/sea.4 | 4 ++--
share/man/man4/uaudio.4 | 4 ++--
share/man/man4/uftdi.4 | 4 ++--
share/man/man4/uha.4 | 4 ++--
share/man/man4/uirda.4 | 4 ++--
share/man/man4/umass.4 | 4 ++--
share/man/man4/umct.4 | 4 ++--
share/man/man4/umidi.4 | 4 ++--
share/man/man4/upl.4 | 4 ++--
share/man/man4/uplcom.4 | 4 ++--
share/man/man4/urio.4 | 4 ++--
share/man/man4/uscanner.4 | 6 +++---
share/man/man4/usscanner.4 | 4 ++--
share/man/man4/wt.4 | 4 ++--
share/man/man4/xi.4 | 27 +++++++++++++++++----------
share/man/man7/packages.7 | 16 ++++++++--------
share/man/man9/pmap.9 | 10 +++++-----
share/man/man9/ucom.9 | 4 ++--
share/man/man9/vnodeops.9 | 4 ++--
usr.bin/error/error.1 | 4 ++--
usr.bin/fstat/fstat.1 | 6 +++---
usr.bin/make/make.1 | 10 +++++-----
usr.bin/pmc/pmc.1 | 4 ++--
usr.bin/rdist/rdist.1 | 4 ++--
usr.sbin/isdn/isdnd/isdnd.rc.5 | 8 ++++----
usr.sbin/pkg_install/add/pkg_add.1 | 4 ++--
56 files changed, 183 insertions(+), 176 deletions(-)
diffs (truncated from 1483 to 300 lines):
diff -r 68d04ad93c9e -r 90dae421d82b dist/bind/man/host.1
--- a/dist/bind/man/host.1 Thu Feb 07 02:52:14 2002 +0000
+++ b/dist/bind/man/host.1 Thu Feb 07 03:15:06 2002 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: host.1,v 1.5 2001/06/05 10:08:04 wiz Exp $
+.\" $NetBSD: host.1,v 1.6 2002/02/07 03:15:06 ross Exp $
.\"
.\" ++Copyright++ 1993
.\" -
@@ -277,14 +277,14 @@
.Ev HOSTALIASES
environment variable.
.Sh ENVIRONMENT
-.Bl -tag -width "/etc/resolv.conf " -compress
+.Bl -tag -width "/etc/resolv.conf " -compact
.It Ev HOSTALIASES
Name of file containing
.Pq Ar host alias , full hostname
pairs.
.El
.Sh FILES
-.Bl -tag -width "/etc/resolv.conf " -compress
+.Bl -tag -width "/etc/resolv.conf " -compact
.It Pa /etc/resolv.conf
See
.Xr resolver 5 .
diff -r 68d04ad93c9e -r 90dae421d82b lib/libc/gen/sysctl.3
--- a/lib/libc/gen/sysctl.3 Thu Feb 07 02:52:14 2002 +0000
+++ b/lib/libc/gen/sysctl.3 Thu Feb 07 03:15:06 2002 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: sysctl.3,v 1.85 2002/01/31 00:32:47 kleink Exp $
+.\" $NetBSD: sysctl.3,v 1.86 2002/02/07 03:15:06 ross Exp $
.\"
.\" Copyright (c) 1993
.\" The Regents of the University of California. All rights reserved.
@@ -42,8 +42,8 @@
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
-.Fd #include <sys/param.h>
-.Fd #include <sys/sysctl.h>
+.Fd #include \*(ltsys/param.h\*(gt
+.Fd #include \*(ltsys/sysctl.h\*(gt
.Ft int
.Fn sysctl "int *name" "u_int namelen" "void *oldp" "size_t *oldlenp" "void *newp" "size_t newlen"
.Sh DESCRIPTION
@@ -114,7 +114,7 @@
set to 0.
.Pp
The top level names are defined with a CTL_ prefix in
-.Pa <sys/sysctl.h> ,
+.Pa Aq sys/sysctl.h ,
and are as follows.
The next and subsequent levels down are found in the include files
listed here, and described in separate sections below.
@@ -1431,7 +1431,7 @@
.Sh CTL_VENDOR
The "vendor" toplevel name is reserved to be used by vendors who wish to
have their own private MIB tree. Intended use is to store values under
-.Dq vendor.<yourname>.* .
+.Dq vendor.\*(ltyourname\*(gt.* .
.Sh RETURN VALUES
If the call to
.Nm
@@ -1441,29 +1441,29 @@
is set appropriately.
.Sh FILES
.Bl -tag -width <netinet6/udp6Xvar.h> -compact
-.It Pa <sys/sysctl.h>
+.It Pa Aq sys/sysctl.h
definitions for top level identifiers, second level kernel and hardware
identifiers, and user level identifiers
-.It Pa <sys/socket.h>
+.It Pa Aq sys/socket.h
definitions for second level network identifiers
-.It Pa <sys/gmon.h>
+.It Pa Aq sys/gmon.h
definitions for third level profiling identifiers
-.It Pa <uvm/uvm_param.h>
+.It Pa Aq uvm/uvm_param.h
definitions for second level virtual memory identifiers
-.It Pa <netinet/in.h>
+.It Pa Aq netinet/in.h
definitions for third level IPv4/v6 identifiers and
fourth level IPv4/v6 identifiers
-.It Pa <netinet/icmp_var.h>
+.It Pa Aq netinet/icmp_var.h
definitions for fourth level ICMP identifiers
-.It Pa <netinet/icmp6.h>
+.It Pa Aq netinet/icmp6.h
definitions for fourth level ICMPv6 identifiers
-.It Pa <netinet/tcp_var.h>
+.It Pa Aq netinet/tcp_var.h
definitions for fourth level TCP identifiers
-.It Pa <netinet/udp_var.h>
+.It Pa Aq netinet/udp_var.h
definitions for fourth level UDP identifiers
-.It Pa <netinet6/udp6_var.h>
+.It Pa Aq netinet6/udp6_var.h
definitions for fourth level IPv6 UDP identifiers
-.It Pa <netinet6/ipsec.h>
+.It Pa Aq netinet6/ipsec.h
definitions for fourth level IPsec identifiers
.El
.Sh ERRORS
diff -r 68d04ad93c9e -r 90dae421d82b libexec/ld.aout_so/ld.aout_so.1
--- a/libexec/ld.aout_so/ld.aout_so.1 Thu Feb 07 02:52:14 2002 +0000
+++ b/libexec/ld.aout_so/ld.aout_so.1 Thu Feb 07 03:15:06 2002 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: ld.aout_so.1,v 1.2 2002/01/15 02:22:54 wiz Exp $
+.\" $NetBSD: ld.aout_so.1,v 1.3 2002/02/07 03:15:07 ross Exp $
.\"
.\" Copyright (c) 1998 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -140,7 +140,7 @@
recognises a number of environment variables that can be used to modify
its behaviour as follows:
.Pp
-.Bl -tag -width "LD_TRACE_LOADED_OBJECTS_PROGNAME"
+.Bl -tag -width LD_TRACE_LOADED_OBJECTS \" intentionally not the longest
.It Ev LD_LIBRARY_PATH
A colon separated list of directories, overriding the default search path
for shared libraries.
@@ -173,7 +173,7 @@
.Xr ldd 1
to be operated as a filter more conveniently.
The following conversions can be used:
-.Bl -tag -indent "LD_TRACE_LOADED_OBJECTS_FMT1 " -width "xxxx"
+.Bl -tag -width xxxx
.It \&%a
The main program's name
.Po also known as
diff -r 68d04ad93c9e -r 90dae421d82b sbin/fsck_ext2fs/fsck_ext2fs.8
--- a/sbin/fsck_ext2fs/fsck_ext2fs.8 Thu Feb 07 02:52:14 2002 +0000
+++ b/sbin/fsck_ext2fs/fsck_ext2fs.8 Thu Feb 07 03:15:06 2002 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: fsck_ext2fs.8,v 1.8 2001/11/16 11:31:30 wiz Exp $
+.\" $NetBSD: fsck_ext2fs.8,v 1.9 2002/02/07 03:15:07 ross Exp $
.\"
.\" Copyright (c) 1997 Manuel Bouyer.
.\" Copyright (c) 1980, 1989, 1991, 1993
@@ -160,7 +160,7 @@
to continue after essentially unlimited trouble has been encountered.
.El
.Pp
-.Bl -enum -indent indent -compact
+.Bl -enum -offset indent -compact
Inconsistencies checked are as follows:
.It
Blocks claimed by more than one inode or the free map.
@@ -170,7 +170,7 @@
Incorrect link counts.
.It
Size checks:
-.Bl -item -indent indent -compact
+.Bl -item -offset indent -compact
.It
Directory size not a multiple of filesystem block size.
.It
@@ -182,7 +182,7 @@
Blocks not accounted for anywhere.
.It
Directory checks:
-.Bl -item -indent indent -compact
+.Bl -item -offset indent -compact
.It
File pointing to unallocated inode.
.It
@@ -193,7 +193,7 @@
.El
.It
Super Block checks:
-.Bl -item -indent indent -compact
+.Bl -item -offset indent -compact
.It
More blocks for inodes than there are in the filesystem.
.It
diff -r 68d04ad93c9e -r 90dae421d82b sbin/fsck_ffs/fsck_ffs.8
--- a/sbin/fsck_ffs/fsck_ffs.8 Thu Feb 07 02:52:14 2002 +0000
+++ b/sbin/fsck_ffs/fsck_ffs.8 Thu Feb 07 03:15:06 2002 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: fsck_ffs.8,v 1.27 2001/11/16 10:11:41 wiz Exp $
+.\" $NetBSD: fsck_ffs.8,v 1.28 2002/02/07 03:15:07 ross Exp $
.\"
.\" Copyright (c) 1980, 1989, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
@@ -221,7 +221,7 @@
to continue after essentially unlimited trouble has been encountered.
.El
.Pp
-.Bl -enum -indent indent -compact
+.Bl -enum -offset indent -compact
Inconsistencies checked are as follows:
.It
Blocks claimed by more than one inode or the free map.
@@ -231,7 +231,7 @@
Incorrect link counts.
.It
Size checks:
-.Bl -item -indent indent -compact
+.Bl -item -offset indent -compact
.It
Directory size not a multiple of DIRBLKSIZ.
.It
@@ -243,7 +243,7 @@
Blocks not accounted for anywhere.
.It
Directory checks:
-.Bl -item -indent indent -compact
+.Bl -item -offset indent -compact
.It
File pointing to unallocated inode.
.It
@@ -254,7 +254,7 @@
.El
.It
Super Block checks:
-.Bl -item -indent indent -compact
+.Bl -item -offset indent -compact
.It
More blocks for inodes than there are in the file system.
.It
diff -r 68d04ad93c9e -r 90dae421d82b sbin/fsck_lfs/fsck_lfs.8
--- a/sbin/fsck_lfs/fsck_lfs.8 Thu Feb 07 02:52:14 2002 +0000
+++ b/sbin/fsck_lfs/fsck_lfs.8 Thu Feb 07 03:15:06 2002 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: fsck_lfs.8,v 1.7 2001/11/16 11:26:55 wiz Exp $
+.\" $NetBSD: fsck_lfs.8,v 1.8 2002/02/07 03:15:07 ross Exp $
.\"
.\" Copyright (c) 1980, 1989, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
@@ -140,7 +140,7 @@
to continue after essentially unlimited trouble has been encountered.
.El
.Pp
-.Bl -enum -indent indent -compact
+.Bl -enum -offset indent -compact
Inconsistencies checked are as follows:
.It
Blocks claimed by more than one inode.
@@ -150,7 +150,7 @@
Incorrect link counts.
.It
Size checks:
-.Bl -item -indent indent -compact
+.Bl -item -offset indent -compact
.It
Directory size not a multiple of DIRBLKSIZ.
.It
@@ -160,7 +160,7 @@
Bad inode format.
.It
Directory checks:
-.Bl -item -indent indent -compact
+.Bl -item -offset indent -compact
.It
File pointing to unallocated inode.
.It
@@ -171,7 +171,7 @@
.El
.It
Super Block checks:
-.Bl -item -indent indent -compact
+.Bl -item -offset indent -compact
.It
More blocks for inodes than there are in the filesystem.
.It
diff -r 68d04ad93c9e -r 90dae421d82b share/man/man4/agp.4
--- a/share/man/man4/agp.4 Thu Feb 07 02:52:14 2002 +0000
+++ b/share/man/man4/agp.4 Thu Feb 07 03:15:06 2002 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: agp.4,v 1.6 2001/11/12 07:33:40 gmcgarry Exp $
+.\" $NetBSD: agp.4,v 1.7 2002/02/07 03:15:07 ross Exp $
.\"
.\" Copyright (c) 2001 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -57,7 +57,7 @@
.Nm
driver supports the following chipsets:
.Pp
-.Bl -dash -compact indent
+.Bl -dash -compact -offset indent
.It
ALI M1541 host-to-AGP bridge
.It
diff -r 68d04ad93c9e -r 90dae421d82b share/man/man4/aha.4
--- a/share/man/man4/aha.4 Thu Feb 07 02:52:14 2002 +0000
+++ b/share/man/man4/aha.4 Thu Feb 07 03:15:06 2002 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: aha.4,v 1.10 2001/09/11 17:39:00 wiz Exp $
+.\" $NetBSD: aha.4,v 1.11 2002/02/07 03:15:08 ross Exp $
.\"
.\" Copyright (c) 1994 James A. Jegers
.\" All rights reserved.
@@ -40,7 +40,7 @@
.Tn SCSI
adapters:
.Pp
-.Bl -tag -width -offset indent -compact
+.Bl -tag -width Dv -offset indent -compact
Home |
Main Index |
Thread Index |
Old Index