jmg
/
ggate
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 2 Wiki Activity
Browse Source

Polish the mdoc(7) markup.

tags/ggatessh-v1.0.0
ru 20 years ago
parent
1c1b7fce8a
commit
c7eb48f80f
3 changed files with 60 additions and 70 deletions
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. +28
    -31
      ggatec/ggatec.8
  2. +9
    -11
      ggated/ggated.8
  3. +23
    -28
      ggatel/ggatel.8

+ 28
- 31
ggatec/ggatec.8 View File

@@ -32,10 +32,10 @@
.Nd "GEOM Gate network client and control utility" .Nd "GEOM Gate network client and control utility"
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Ar create
.Cm create
.Op Fl n .Op Fl n
.Op Fl v .Op Fl v
.Op Fl o Ar ro | wo | rw
.Op Fl o Cm ro | wo | rw
.Op Fl p Ar port .Op Fl p Ar port
.Op Fl q Ar queue_size .Op Fl q Ar queue_size
.Op Fl R Ar rcvbuf .Op Fl R Ar rcvbuf
@@ -46,10 +46,10 @@
.Ar host .Ar host
.Ar path .Ar path
.Nm .Nm
.Ar attach
.Cm attach
.Op Fl n .Op Fl n
.Op Fl v .Op Fl v
.Op Fl o Ar ro | wo | rw
.Op Fl o Cm ro | wo | rw
.Op Fl p Ar port .Op Fl p Ar port
.Op Fl R Ar rcvbuf .Op Fl R Ar rcvbuf
.Op Fl S Ar sndbuf .Op Fl S Ar sndbuf
@@ -57,11 +57,11 @@
.Ar host .Ar host
.Ar path .Ar path
.Nm .Nm
.Ar destroy
.Cm destroy
.Op Fl f .Op Fl f
.Fl u Ar unit .Fl u Ar unit
.Nm .Nm
.Ar list
.Cm list
.Op Fl v .Op Fl v
.Op Fl u Ar unit .Op Fl u Ar unit
.Sh DESCRIPTION .Sh DESCRIPTION
@@ -73,49 +73,51 @@ It is responsible for creation of
devices and forwarding I/O requests between devices and forwarding I/O requests between
.Nm geom_gate.ko .Nm geom_gate.ko
kernel module and kernel module and
.Nm ggated
.Xr ggated 8
network daemon. network daemon.
Available commands: Available commands:
.Bl -tag -width ".Ar destroy"
.It Ar create
.Bl -tag -width ".Cm destroy"
.It Cm create
Connect to given Connect to given
.Nm ggated
.Xr ggated 8
daemon and create a daemon and create a
.Nm ggate .Nm ggate
provider related to the given remote file or device. provider related to the given remote file or device.
.It Ar attach
.It Cm attach
Attach a worker process to an existing Attach a worker process to an existing
.Nm ggate .Nm ggate
provider (create a new connection to the provider (create a new connection to the
.Nm ggated
.Xr ggated 8
daemon). daemon).
.It Ar destroy
.It Cm destroy
Destroy the given Destroy the given
.Nm ggate .Nm ggate
provider. provider.
.It Ar list
.It Cm list
List List
.Nm ggate .Nm ggate
providers. providers.
.El .El
.Pp .Pp
Available options: Available options:
.Bl -tag -width ".Fl s Ar ro | wo | rw"
.Bl -tag -width ".Fl s Cm ro | wo | rw"
.It Fl f .It Fl f
Forcibly destroy Forcibly destroy
.Nm ggate .Nm ggate
provider (cancels all pending requests). provider (cancels all pending requests).
.It Fl n .It Fl n
Do not use TCP_NODELAY option on TCP sockets.
.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 ) .
Do not use
.Dv TCP_NODELAY
option on TCP sockets.
.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 Default is
.Ar rw .
.Cm rw .
.It Fl p Ar port .It Fl p Ar port
Port to connect to on the remote host. Port to connect to on the remote host.
Default is 3080. Default is 3080.
@@ -133,7 +135,7 @@ Default is 131072 (128kB).
Sector size for Sector size for
.Nm ggate .Nm ggate
provider. 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 .It Fl t Ar timeout
Number of seconds to wait before an I/O request will be canceled. Number of seconds to wait before an I/O request will be canceled.
0 means no timeout. 0 means no timeout.
@@ -148,10 +150,8 @@ Remote host to connect to.
.It Ar path .It Ar path
Path to a regular file or device. Path to a regular file or device.
.El .El
.Pp
.Sh EXAMPLES .Sh EXAMPLES
Made use of CD\-ROM device from remote host.
.Pp
Made use of CD-ROM device from remote host.
.Bd -literal -offset indent .Bd -literal -offset indent
server# cat /etc/gg.exports server# cat /etc/gg.exports
client RO /dev/acd0 client RO /dev/acd0
@@ -161,7 +161,6 @@ client# ggatec create -o ro server /dev/acd0
ggate0 ggate0
client# mount_cd9660 /dev/ggate0 /cdrom client# mount_cd9660 /dev/ggate0 /cdrom
.Ed .Ed
.Pp
.Sh DIAGNOSTICS .Sh DIAGNOSTICS
Exit status is 0 on success, or 1 if the command fails. Exit status is 0 on success, or 1 if the command fails.
To get details about the failure, To get details about the failure,
@@ -178,6 +177,4 @@ option.
The The
.Nm .Nm
utility as well as this manual page was written by utility as well as this manual page was written by
.An -split
.An Pawel Jakub Dawidek Aq pjd@FreeBSD.org . .An Pawel Jakub Dawidek Aq pjd@FreeBSD.org .
.An -nosplit

+ 9
- 11
ggated/ggated.8 View File

@@ -47,23 +47,26 @@ utility is a network server for GEOM Gate class.
It runs on a server machine to service GEOM Gate requests from workers It runs on a server machine to service GEOM Gate requests from workers
placed on a client machine. placed on a client machine.
Keep in mind, that connection between Keep in mind, that connection between
.Nm ggatec
.Xr ggatec 8
and and
.Nm ggated
.Nm
is not encrypted. is not encrypted.
.Pp .Pp
Available options: Available options:
.Bl -tag -width ".Ar exports file"
.Bl -tag -width ".Ar exports\ file"
.It Fl a Ar address .It Fl a Ar address
Specifies an IP address to bind to. Specifies an IP address to bind to.
.It Fl h .It Fl h
Print available options. Print available options.
.It Fl n .It Fl n
Do not use TCP_NODELAY option on TCP sockets.
Do not use
.Dv TCP_NODELAY
option on TCP sockets.
.It Fl p Ar port .It Fl p Ar port
Port on which Port on which
.Nm .Nm
listens for connection. Default is 3080.
listens for connection.
Default is 3080.
.It Fl R Ar rcvbuf .It Fl R Ar rcvbuf
Size of receive buffer to use. Size of receive buffer to use.
Default is 131072 (128kB). Default is 131072 (128kB).
@@ -83,16 +86,13 @@ The format of an exports file is as follows:
1.2.3.0/24 RW /tmp/test.img 1.2.3.0/24 RW /tmp/test.img
hostname WO /tmp/image hostname WO /tmp/image
.Ed .Ed
.Pp
.Sh EXAMPLES .Sh EXAMPLES
Export CD\-ROM device and a file:
.Pp
Export CD-ROM device and a file:
.Bd -literal -offset indent .Bd -literal -offset indent
# echo "1.2.3.0/24 RO /dev/acd0" > /etc/gg.exports # echo "1.2.3.0/24 RO /dev/acd0" > /etc/gg.exports
# echo "client RW /image" >> /etc/gg.exports # echo "client RW /image" >> /etc/gg.exports
# ggated # ggated
.Ed .Ed
.Pp
.Sh DIAGNOSTICS .Sh DIAGNOSTICS
Exit status is 0 on success, or 1 if the command fails. Exit status is 0 on success, or 1 if the command fails.
To get details about the failure, To get details about the failure,
@@ -108,6 +108,4 @@ option.
The The
.Nm .Nm
utility as well as this manual page was written by utility as well as this manual page was written by
.An -split
.An Pawel Jakub Dawidek Aq pjd@FreeBSD.org . .An Pawel Jakub Dawidek Aq pjd@FreeBSD.org .
.An -nosplit

+ 23
- 28
ggatel/ggatel.8 View File

@@ -32,26 +32,26 @@
.Nd "GEOM Gate local control utility" .Nd "GEOM Gate local control utility"
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Ar create
.Cm create
.Op Fl v .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 q Ar queue_size
.Op Fl s Ar sectorsize .Op Fl s Ar sectorsize
.Op Fl t Ar timeout .Op Fl t Ar timeout
.Op Fl u Ar unit .Op Fl u Ar unit
.Ar path .Ar path
.Nm .Nm
.Ar attach
.Cm attach
.Op Fl v .Op Fl v
.Op Fl o Ar ro | wo | rw
.Op Fl o Cm ro | wo | rw
.Fl u Ar unit .Fl u Ar unit
.Ar path .Ar path
.Nm .Nm
.Ar destroy
.Cm destroy
.Op Fl f .Op Fl f
.Fl u Ar unit .Fl u Ar unit
.Nm .Nm
.Ar list
.Cm list
.Op Fl v .Op Fl v
.Op Fl u Ar unit .Op Fl u Ar unit
.Sh DESCRIPTION .Sh DESCRIPTION
@@ -62,44 +62,44 @@ It can be used as a replacement for
.Xr md 4 .Xr md 4
devices or as a devices or as a
.Dq GEOMificator .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. on how to use and how to communicate with the GEOM Gate kernel module.
.Pp .Pp
Available commands: Available commands:
.Bl -tag -width ".Ar destroy"
.It Ar create
.Bl -tag -width ".Cm destroy"
.It Cm create
Create a Create a
.Nm ggate .Nm ggate
provider related to the given regular file or device. provider related to the given regular file or device.
.It Ar attach
.It Cm attach
Attach a worker process to an existing Attach a worker process to an existing
.Nm ggate .Nm ggate
provider. provider.
.It Ar destroy
.It Cm destroy
Destroy the given Destroy the given
.Nm ggate .Nm ggate
provider. provider.
.It Ar list
.It Cm list
List List
.Nm ggate .Nm ggate
providers. providers.
.El .El
.Pp .Pp
Available options: Available options:
.Bl -tag -width ".Fl s Ar ro | wo | rw"
.Bl -tag -width ".Fl s Cm ro | wo | rw"
.It Fl f .It Fl f
Forcibly destroy Forcibly destroy
.Nm ggate .Nm ggate
provider (cancels all pending requests). 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 Default is
.Ar rw .
.Cm rw .
.It Fl q Ar queue_size .It Fl q Ar queue_size
Number of pending I/O requests that can be queued before they will Number of pending I/O requests that can be queued before they will
start to be canceled. start to be canceled.
@@ -108,7 +108,7 @@ Default is 1024.
Sector size for Sector size for
.Nm ggate .Nm ggate
provider. 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 .It Fl t Ar timeout
Number of seconds to wait before an I/O request will be canceled. Number of seconds to wait before an I/O request will be canceled.
0 means no timeout. 0 means no timeout.
@@ -121,15 +121,13 @@ output.
.It Ar path .It Ar path
Path to a regular file or device. Path to a regular file or device.
.El .El
.Pp
.Sh EXAMPLES .Sh EXAMPLES
.Dq GEOMify .Dq GEOMify
the the
.Li fd0
.Dq Li fd0
device and use device and use
.Xr gbde 8 .Xr gbde 8
to encrypt data on a floppy. to encrypt data on a floppy.
.Pp
.Bd -literal -offset indent .Bd -literal -offset indent
ggatel create -u 5 /dev/fd0 ggatel create -u 5 /dev/fd0
gbde init /dev/ggate5 gbde init /dev/ggate5
@@ -141,7 +139,6 @@ umount /secret
gbde detach ggate5 gbde detach ggate5
ggatel destroy -u 5 ggatel destroy -u 5
.Ed .Ed
.Pp
.Sh DIAGNOSTICS .Sh DIAGNOSTICS
Exit status is 0 on success, or 1 if the command fails. Exit status is 0 on success, or 1 if the command fails.
To get details about the failure, To get details about the failure,
@@ -160,6 +157,4 @@ option.
The The
.Nm .Nm
utility as well as this manual page was written by utility as well as this manual page was written by
.An -split
.An Pawel Jakub Dawidek Aq pjd@FreeBSD.org . .An Pawel Jakub Dawidek Aq pjd@FreeBSD.org .
.An -nosplit

Write Preview
Loading…
Cancel
Save