@@ -32,10 +32,10 @@ | |||
.Nd "GEOM Gate network client and control utility" | |||
.Sh SYNOPSIS | |||
.Nm | |||
.Ar create | |||
.Cm create | |||
.Op Fl n | |||
.Op Fl v | |||
.Op Fl o Ar ro | wo | rw | |||
.Op Fl o Cm ro | wo | rw | |||
.Op Fl p Ar port | |||
.Op Fl q Ar queue_size | |||
.Op Fl R Ar rcvbuf | |||
@@ -46,10 +46,10 @@ | |||
.Ar host | |||
.Ar path | |||
.Nm | |||
.Ar attach | |||
.Cm attach | |||
.Op Fl n | |||
.Op Fl v | |||
.Op Fl o Ar ro | wo | rw | |||
.Op Fl o Cm ro | wo | rw | |||
.Op Fl p Ar port | |||
.Op Fl R Ar rcvbuf | |||
.Op Fl S Ar sndbuf | |||
@@ -57,11 +57,11 @@ | |||
.Ar host | |||
.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 | |||
@@ -73,49 +73,51 @@ It is responsible for creation of | |||
devices and forwarding I/O requests between | |||
.Nm geom_gate.ko | |||
kernel module and | |||
.Nm ggated | |||
.Xr ggated 8 | |||
network daemon. | |||
Available commands: | |||
.Bl -tag -width ".Ar destroy" | |||
.It Ar create | |||
.Bl -tag -width ".Cm destroy" | |||
.It Cm create | |||
Connect to given | |||
.Nm ggated | |||
.Xr ggated 8 | |||
daemon and create a | |||
.Nm ggate | |||
provider related to the given remote file or device. | |||
.It Ar attach | |||
.It Cm attach | |||
Attach a worker process to an existing | |||
.Nm ggate | |||
provider (create a new connection to the | |||
.Nm ggated | |||
.Xr ggated 8 | |||
daemon). | |||
.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 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 | |||
.Ar rw . | |||
.Cm rw . | |||
.It Fl p Ar port | |||
Port to connect to on the remote host. | |||
Default is 3080. | |||
@@ -133,7 +135,7 @@ Default is 131072 (128kB). | |||
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. | |||
@@ -148,10 +150,8 @@ Remote host to connect to. | |||
.It Ar path | |||
Path to a regular file or device. | |||
.El | |||
.Pp | |||
.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 | |||
server# cat /etc/gg.exports | |||
client RO /dev/acd0 | |||
@@ -161,7 +161,6 @@ client# ggatec create -o ro server /dev/acd0 | |||
ggate0 | |||
client# mount_cd9660 /dev/ggate0 /cdrom | |||
.Ed | |||
.Pp | |||
.Sh DIAGNOSTICS | |||
Exit status is 0 on success, or 1 if the command fails. | |||
To get details about the failure, | |||
@@ -178,6 +177,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 |
@@ -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 | |||
placed on a client machine. | |||
Keep in mind, that connection between | |||
.Nm ggatec | |||
.Xr ggatec 8 | |||
and | |||
.Nm ggated | |||
.Nm | |||
is not encrypted. | |||
.Pp | |||
Available options: | |||
.Bl -tag -width ".Ar exports file" | |||
.Bl -tag -width ".Ar exports\ file" | |||
.It Fl a Ar address | |||
Specifies an IP address to bind to. | |||
.It Fl h | |||
Print available options. | |||
.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 | |||
Port on which | |||
.Nm | |||
listens for connection. Default is 3080. | |||
listens for connection. | |||
Default is 3080. | |||
.It Fl R Ar rcvbuf | |||
Size of receive buffer to use. | |||
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 | |||
hostname WO /tmp/image | |||
.Ed | |||
.Pp | |||
.Sh EXAMPLES | |||
Export CD\-ROM device and a file: | |||
.Pp | |||
Export CD-ROM device and a file: | |||
.Bd -literal -offset indent | |||
# echo "1.2.3.0/24 RO /dev/acd0" > /etc/gg.exports | |||
# echo "client RW /image" >> /etc/gg.exports | |||
# ggated | |||
.Ed | |||
.Pp | |||
.Sh DIAGNOSTICS | |||
Exit status is 0 on success, or 1 if the command fails. | |||
To get details about the failure, | |||
@@ -108,6 +108,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 |
@@ -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 |