NAME

ggatel — GEOM Gate local control utility

SYNOPSIS

DESCRIPTION

The ggatel utility is a local GEOM Gate class consumer. It can be used as a replacement for md(4) devices or as a “GEOMificator” 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 subsystem.

Available commands:

create

Create a ggate provider related to the given regular file or device.

destroy

Destroy the given ggate provider.

list

List ggate providers.

rescue

Take over a previously created provider and handle pending and future requests. This is useful if the initial ggatel process died. To prevent data loss, the given path must lead to the regular file or device that was used to create the provider.

Available options:

-f

Forcibly destroy ggate provider (cancels all pending requests).

-o option

Specify permissions and options to use when opening the file or device.

ro

read-only

wo

write-only

rw

read-write

direct

open with O_DIRECT option on the file

Default is rw.

-s sectorsize

Sector size for ggate provider. If not specified, it is taken from the device, or set to 512 bytes for files.

-t timeout

Number of seconds to wait before an I/O request will be canceled. 0 means no timeout. Default is 30.

-u unit

Unit number to use.

-v

Do not fork, run in foreground and print debug information on standard output.

path

Path to a regular file or device.

EXIT STATUS

Exit status is 0 on success, or 1 if the command fails. To get details about the failure, ggatel should be called with the -v option.

SEE ALSO

geom(4), ggatec(8), ggated(8), mount(8), newfs(8)

HISTORY

The ggatel utility appeared in FreeBSD 5.3.

AUTHORS

The ggatel utility as well as this manual page was written by Pawel Jakub Dawidek <pjd@FreeBSD.org>.