From 40d1fffb985039d6b43aae35d60d38979078afcb Mon Sep 17 00:00:00 2001 From: Prasanna Kumar Kalever Date: Tue, 6 Jun 2017 12:58:23 +0530 Subject: docs: add manual for gluster-blockd Change-Id: Ic8a7d584274f48dcef5ea2356cf317352a3d48ef Signed-off-by: Prasanna Kumar Kalever --- docs/Makefile.am | 4 +-- docs/gluster-block.8 | 6 ++-- docs/gluster-blockd.8 | 91 +++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 97 insertions(+), 4 deletions(-) create mode 100644 docs/gluster-blockd.8 (limited to 'docs') diff --git a/docs/Makefile.am b/docs/Makefile.am index 2430f96..eed64a8 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,6 +1,6 @@ -EXTRA_DIST = gluster-block.8 +EXTRA_DIST = gluster-block.8 gluster-blockd.8 -man8_MANS = gluster-block.8 +man8_MANS = gluster-block.8 gluster-blockd.8 DISTCLEANFILES = Makefile.in diff --git a/docs/gluster-block.8 b/docs/gluster-block.8 index 44da3d3..83cfdf3 100644 --- a/docs/gluster-block.8 +++ b/docs/gluster-block.8 @@ -63,7 +63,7 @@ modify block device. .SS .BR help -show this message and exit. +show help message and exit. .PP .SS @@ -115,6 +115,8 @@ To delete a block device /var/run/gluster-block.socket .br /var/run/gluster-block.lock +.br +/etc/sysconfig/gluster-blockd-config .PP @@ -136,7 +138,7 @@ Pranith Kumar Karampuri .SH SEE ALSO .nf -\fBtargetcli\fR(8), \fBtcmu-runner\fR(8), \fBglusterfs\fR(8), \fBglusterd\fR(8), \fBgluster\fR(8) +\fBgluster-blockd\fR(8), \fBtargetcli\fR(8), \fBtcmu-runner\fR(8), \fBglusterfs\fR(8), \fBglusterd\fR(8), \fBgluster\fR(8) .fi .PP diff --git a/docs/gluster-blockd.8 b/docs/gluster-blockd.8 new file mode 100644 index 0000000..80655c1 --- /dev/null +++ b/docs/gluster-blockd.8 @@ -0,0 +1,91 @@ +.TH gluster-blockd 8 "management daemon" "06 Jun 2017" "Red Hat, Inc." +.PP + + +.SH NAME +gluster-blockd - Gluster Block Management Daemon +.PP + + +.SH SYNOPSIS +.B gluster-blockd +[\fBOPTION...\fR] +.PP + + +.SH DESCRIPTION +gluster-blockd daemon is responsible for block management, hence the daemon must be running on all servers. +.PP + + +.SH OPTIONS +.SS "Basic Options" + +.TP +\fB\-\-glfs\-lru\-count\fR +glfs objects cache capacity [max: 512] [default: 5] +.TP +\fB\-\-log\-level\fR +Logging severity. Valid options are TRACE, DEBUG, INFO, WARNING, ERROR and NONE [default: INFO]. + + +.SS "Miscellaneous Options" +.TP +\fB usage | help\fR +Display a usage message. +.TP +\fB version\fR +Print the program version. + + +.SH EXAMPLES +.nf +With lru cache capacity 10 +.B # gluster-blockd --glfs-cache-count 10 + +To choose log-level DEBUG +.B # gluster-blockd --log-level DEBUG + +With lru cache capacity 8 and log-level ERROR +.B # gluster-blockd --glfs-cache-count 8 --log-level ERROR +.fi +.PP + + +.SH FILES +/var/log/gluster-block/* +.br +/var/run/gluster-blockd.socket +.br +/var/run/gluster-blockd.lock +.br +/etc/sysconfig/gluster-blockd-config +.PP + + +.SH REPORTING BUGS +Report bugs via gluster-devel + + +.SH AUTHOR +Prasanna Kumar Kalever + +.SH THANKS +Vijay Bellur +.br +Pranith Kumar Karampuri + + +.SH SEE ALSO +.nf +\fBgluster-block\fR(8), \fBtargetcli\fR(8), \fBtcmu-runner\fR(8), \fBglusterfs\fR(8), \fBglusterd\fR(8), \fBgluster\fR(8) +.fi +.PP + + +.SH COPYRIGHT +.nf +Copyright (c) 2016 Red Hat, Inc. +.PP -- cgit