diff options
author | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2011-07-23 15:40:14 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2011-07-23 15:40:14 +0000 |
commit | a5537fa70156ca4b6be82663af741b145d316905 (patch) | |
tree | 4ca31bfcf294e04a8f971ee389b3f19e81429654 /usr.sbin/rmt | |
parent | 15a086bab61b433f3905b3f8aebe694baef41d3e (diff) |
Add missing .Sm macros (from matthew@).
While here,
* use .Ic rather than .Sy for commands and fix an .Xr
* remove duplicate $Id$ and multiple useless .Tn and .Xo
* avoid lengthy .Bd and .Sm where they are not needed
OK matthew@ jmc@
Diffstat (limited to 'usr.sbin/rmt')
-rw-r--r-- | usr.sbin/rmt/rmt.8 | 63 |
1 files changed, 21 insertions, 42 deletions
diff --git a/usr.sbin/rmt/rmt.8 b/usr.sbin/rmt/rmt.8 index 92455d77467..a48d3d5e3dc 100644 --- a/usr.sbin/rmt/rmt.8 +++ b/usr.sbin/rmt/rmt.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rmt.8,v 1.11 2007/05/31 19:20:28 jmc Exp $ +.\" $OpenBSD: rmt.8,v 1.12 2011/07/23 15:40:13 schwarze Exp $ .\" .\" Copyright (c) 1983, 1991 The Regents of the University of California. .\" All rights reserved. @@ -28,9 +28,8 @@ .\" SUCH DAMAGE. .\" .\" from: @(#)rmt.8 6.5 (Berkeley) 3/16/91 -.\" $Id: rmt.8,v 1.11 2007/05/31 19:20:28 jmc Exp $ .\" -.Dd $Mdocdate: May 31 2007 $ +.Dd $Mdocdate: July 23 2011 $ .Dt RMT 8 .Os .Sh NAME @@ -55,28 +54,17 @@ The program accepts requests specific to the manipulation of magnetic tapes, performs the commands, then responds with a status indication. -All responses are in -.Tn ASCII -and in -one of two forms. +All responses are in ASCII and in one of two forms. Successful commands have responses of: -.Bd -filled -offset indent -.Sm off -.Sy A Ar number No \en -.Sm on -.Ed +.Pp +.D1 Sy A Ns Ar number Ns \en .Pp .Ar number -is an -.Tn ASCII -representation of a decimal number. +is an ASCII representation of a decimal number. Unsuccessful commands are responded to with: .Bd -filled -offset indent .Sm off -.Xo Sy E Ar error-number -.No \en Ar error-message -.No \en -.Xc +.Sy E Ar error-number No \en Ar error-message No \en .Sm on .Ed .Pp @@ -96,9 +84,10 @@ between the command and its arguments, or between its arguments, and indicates that a newline should be supplied: .Bl -tag -width Ds .Sm off -.It Xo Sy \&O Ar device +.It Xo Ic \&O Ar device .No \en Ar mode No \en .Xc +.Sm on Open the specified .Ar device using the indicated @@ -106,20 +95,18 @@ using the indicated .Ar device is a full pathname and .Ar mode -is an -.Tn ASCII -representation of a decimal +is an ASCII representation of a decimal number suitable for passing to .Xr open 2 . If a device had already been opened, it is closed before a new open is performed. -.It Xo Sy C Ar device No \en -.Xc +.It Ic C Ns Ar device Ns \en Close the currently open device. The .Ar device specified is ignored. -.It Xo Sy L +.Sm off +.It Xo Ic L .Ar offset No \en .Ar whence No \en .Xc @@ -128,11 +115,9 @@ Perform an .Xr lseek 2 operation using the specified parameters. The response value is that returned from the -.Xr lseek +.Xr lseek 2 call. -.Sm off -.It Sy W Ar count No \en -.Sm on +.It Ic W Ns Ar count Ns \en Write data onto the open device. .Nm reads @@ -143,9 +128,7 @@ The response value is that returned from the .Xr write 2 call. -.Sm off -.It Sy R Ar count No \en -.Sm on +.It Ic R Ns Ar count Ns \en Read .Ar count bytes of data from the open device. @@ -157,15 +140,13 @@ truncated to the data buffer size. then performs the requested .Xr read 2 and responds with -.Sm off -.Sy A Ar count-read No \en -.Sm on +.Sy A Ns Ar count-read Ns \en if the read was successful; otherwise an error in the standard format is returned. If the read was successful, the data read is then sent. .Sm off -.It Xo Sy I Ar operation +.It Xo Ic I Ar operation .No \en Ar count No \en .Xc .Sm on @@ -174,19 +155,18 @@ Perform an .Xr ioctl 2 command using the specified parameters. The parameters are interpreted as the -.Tn ASCII -representations of the decimal values +ASCII representations of the decimal values to place in the .Ar mt_op and .Ar mt_count fields of the structure used in the -.Fn ioctl +.Xr ioctl 2 call. The return value is the .Ar count parameter when the operation is successful. -.It Sy S +.It Ic S Return the status of the open device, as obtained with a .Dv MTIOCGET @@ -197,7 +177,6 @@ If the operation was successful, an is sent with the size of the status buffer, then the status buffer is sent (in binary). .El -.Sm on .Pp Any other command causes .Nm |