aboutsummaryrefslogtreecommitdiff
path: root/sbin/ggate/ggatel
diff options
context:
space:
mode:
authorRuslan Ermilov <ru@FreeBSD.org>2004-05-12 07:34:05 +0000
committerRuslan Ermilov <ru@FreeBSD.org>2004-05-12 07:34:05 +0000
commit566080063262bc0032946bd7f5406548c1130e2f (patch)
treec4eb8edf58700dcbe4796869fe841da31e17f4af /sbin/ggate/ggatel
parent466b960f3a6974aa4b03516bd206aa90bf85cf28 (diff)
downloadsrc-566080063262bc0032946bd7f5406548c1130e2f.tar.gz
src-566080063262bc0032946bd7f5406548c1130e2f.zip
Polish the mdoc(7) markup.
Notes
Notes: svn path=/head/; revision=129149
Diffstat (limited to 'sbin/ggate/ggatel')
-rw-r--r--sbin/ggate/ggatel/ggatel.851
1 files changed, 23 insertions, 28 deletions
diff --git a/sbin/ggate/ggatel/ggatel.8 b/sbin/ggate/ggatel/ggatel.8
index b0b6edf043ec..f08edeefcc47 100644
--- a/sbin/ggate/ggatel/ggatel.8
+++ b/sbin/ggate/ggatel/ggatel.8
@@ -32,26 +32,26 @@
.Nd "GEOM Gate local control utility"
.Sh SYNOPSIS
.Nm
-.Ar create
+.Cm create
.Op Fl v
-.Op Fl o Ar ro | wo | rw
+.Op Fl o Cm ro | wo | rw
.Op Fl q Ar queue_size
.Op Fl s Ar sectorsize
.Op Fl t Ar timeout
.Op Fl u Ar unit
.Ar path
.Nm
-.Ar attach
+.Cm attach
.Op Fl v
-.Op Fl o Ar ro | wo | rw
+.Op Fl o Cm ro | wo | rw
.Fl u Ar unit
.Ar path
.Nm
-.Ar destroy
+.Cm destroy
.Op Fl f
.Fl u Ar unit
.Nm
-.Ar list
+.Cm list
.Op Fl v
.Op Fl u Ar unit
.Sh DESCRIPTION
@@ -62,44 +62,44 @@ It can be used as a replacement for
.Xr md 4
devices or as a
.Dq GEOMificator
-for non GEOM\-aware devices, but it was mainly created as an example
+for non GEOM-aware devices, but it was mainly created as an example
on how to use and how to communicate with the GEOM Gate kernel module.
.Pp
Available commands:
-.Bl -tag -width ".Ar destroy"
-.It Ar create
+.Bl -tag -width ".Cm destroy"
+.It Cm create
Create a
.Nm ggate
provider related to the given regular file or device.
-.It Ar attach
+.It Cm attach
Attach a worker process to an existing
.Nm ggate
provider.
-.It Ar destroy
+.It Cm destroy
Destroy the given
.Nm ggate
provider.
-.It Ar list
+.It Cm list
List
.Nm ggate
providers.
.El
.Pp
Available options:
-.Bl -tag -width ".Fl s Ar ro | wo | rw"
+.Bl -tag -width ".Fl s Cm ro | wo | rw"
.It Fl f
Forcibly destroy
.Nm ggate
provider (cancels all pending requests).
-.It Fl o Ar ro | wo | rw
-Specify permission to use when opening the file or device: read\-only
-.Ar ( ro ) ,
-write\-only
-.Ar ( wo ) ,
-or read\-write
-.Ar ( rw ) .
+.It Fl o Cm ro | wo | rw
+Specify permission to use when opening the file or device: read-only
+.Pq Cm ro ,
+write-only
+.Pq Cm wo ,
+or read-write
+.Pq Cm rw .
Default is
-.Ar rw .
+.Cm rw .
.It Fl q Ar queue_size
Number of pending I/O requests that can be queued before they will
start to be canceled.
@@ -108,7 +108,7 @@ Default is 1024.
Sector size for
.Nm ggate
provider.
-If not specified, it is taken from device or set to 512 bytes for files.
+If not specified, it is taken from device, or set to 512 bytes for files.
.It Fl t Ar timeout
Number of seconds to wait before an I/O request will be canceled.
0 means no timeout.
@@ -121,15 +121,13 @@ output.
.It Ar path
Path to a regular file or device.
.El
-.Pp
.Sh EXAMPLES
.Dq GEOMify
the
-.Li fd0
+.Dq Li fd0
device and use
.Xr gbde 8
to encrypt data on a floppy.
-.Pp
.Bd -literal -offset indent
ggatel create -u 5 /dev/fd0
gbde init /dev/ggate5
@@ -141,7 +139,6 @@ umount /secret
gbde detach ggate5
ggatel destroy -u 5
.Ed
-.Pp
.Sh DIAGNOSTICS
Exit status is 0 on success, or 1 if the command fails.
To get details about the failure,
@@ -160,6 +157,4 @@ option.
The
.Nm
utility as well as this manual page was written by
-.An -split
.An Pawel Jakub Dawidek Aq pjd@FreeBSD.org .
-.An -nosplit