linux-nfs.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Chuck Lever <chuck.lever@oracle.com>
To: linux-nfs@vger.kernel.org
Cc: Chuck Lever <chuck.lever@oracle.com>
Subject: [PATCH 03/11] gssd: Use italics for option values and pathnames
Date: Fri, 08 Mar 2013 14:46:30 -0500	[thread overview]
Message-ID: <20130308194630.5656.81032.stgit@seurat.1015granger.net> (raw)
In-Reply-To: <20130308193830.5656.44184.stgit@seurat.1015granger.net>

Clean up: The usual convention for the values of command line
options and for pathnames is for them to appear italicized,
rather than emboldened or in double quotes.

Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
---

 utils/gssd/gssd.man |   30 +++++++++++++++++++++---------
 1 files changed, 21 insertions(+), 9 deletions(-)

diff --git a/utils/gssd/gssd.man b/utils/gssd/gssd.man
index c74b7e8..0cc7bf4 100644
--- a/utils/gssd/gssd.man
+++ b/utils/gssd/gssd.man
@@ -6,7 +6,18 @@
 .SH NAME
 rpc.gssd \- rpcsec_gss daemon
 .SH SYNOPSIS
-.B "rpc.gssd [-f] [-n] [-k keytab] [-l] [-p pipefsdir] [-v] [-r] [-d ccachedir]"
+.B rpc.gssd
+.RB [ \-fnlvr ]
+.RB [ \-k
+.IR keytab ]
+.RB [ \-p
+.IR pipefsdir ]
+.RB [ \-d
+.IR ccachedir ]
+.RB [ \-t
+.IR timeout ]
+.RB [ \-R
+.IR realm ]
 .SH DESCRIPTION
 The rpcsec_gss protocol gives a means of using the gss-api generic security
 api to provide security for protocols using rpc (in particular, nfs).  Before
@@ -38,13 +49,14 @@ manually like all other users.  Use of this option means that
 attempting to mount an nfs filesystem requiring Kerberos
 authentication.
 .TP
-.B -k keytab
+.BI "-k " keytab
 Tells
 .B rpc.gssd
 to use the keys found in
 .I keytab
 to obtain "machine credentials".
-The default value is "/etc/krb5.keytab".
+The default value is
+.I /etc/krb5.keytab.
 .IP
 Previous versions of
 .B rpc.gssd
@@ -94,17 +106,17 @@ encryption.
 This option is only available with Kerberos libraries that 
 support setable encryption types.
 .TP
-.B -p path
+.BI "-p " path
 Tells
 .B rpc.gssd
 where to look for the rpc_pipefs filesystem.  The default value is
-"/var/lib/nfs/rpc_pipefs".
+.IR /var/lib/nfs/rpc_pipefs .
 .TP
-.B -d directory
+.BI "-d " directory
 Tells
 .B rpc.gssd
 where to look for Kerberos credential files.  The default value is
-"/tmp:/run/user/%U".
+.IR /tmp:/run/user/%U .
 This can also be a colon separated list of directories to be searched for
 Kerberos credential files.  The sequence "%U", if used, is replaced with
 the UID of the user for whom credentials are being searched.
@@ -119,14 +131,14 @@ Increases the verbosity of the output (can be specified multiple times).
 If the rpcsec_gss library supports setting debug level,
 increases the verbosity of the output (can be specified multiple times).
 .TP
-.B -R realm
+.BI "-R " realm
 Kerberos tickets from this
 .I realm
 will be preferred when scanning available credentials cache files to be
 used to create a context.  By default, the default realm, as configured
 in the Kerberos configuration file, is preferred.
 .TP
-.B -t timeout
+.BI "-t " timeout
 Timeout, in seconds, for kernel gss contexts. This option allows you to force 
 new kernel contexts to be negotiated after
 .I timeout


  parent reply	other threads:[~2013-03-08 19:46 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-03-08 19:46 [PATCH 00/11] gssd clean-ups for nfs-utils Chuck Lever
2013-03-08 19:46 ` [PATCH 01/11] mountd: remove unused variable Chuck Lever
2013-03-08 19:46 ` [PATCH 02/11] mountd: make local functions in v4root.c static Chuck Lever
2013-03-08 19:46 ` Chuck Lever [this message]
2013-03-08 19:46 ` [PATCH 04/11] gssd: gssd.man is missing a description of the "-M" option Chuck Lever
2013-03-08 19:46 ` [PATCH 05/11] gssd: Provide an introduction in gssd(8) Chuck Lever
2013-03-08 19:46 ` [PATCH 06/11] gssd: Clarify use of the term "machine credentials" in rpc.gssd(8) Chuck Lever
2013-03-08 19:47 ` [PATCH 07/11] gssd: Update description of "-l" option Chuck Lever
2013-03-08 19:47 ` [PATCH 08/11] rpc.gssd: Clean up gssd_setup_krb5_user_gss_ccache() Chuck Lever
2013-03-11 12:02   ` Jeff Layton
2013-03-12 20:04     ` Chuck Lever
2013-03-08 19:47 ` [PATCH 09/11] gssd: Fix whitespace nits Chuck Lever
2013-03-08 19:47 ` [PATCH 10/11] gssd: gethostname(3) returns zero or -1, not an errno Chuck Lever
2013-03-08 19:47 ` [PATCH 11/11] gssd: Add "-c" command line option Chuck Lever
2013-03-11 17:58   ` J. Bruce Fields
2013-03-11 17:59     ` J. Bruce Fields
2013-03-12 19:05     ` Chuck Lever

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20130308194630.5656.81032.stgit@seurat.1015granger.net \
    --to=chuck.lever@oracle.com \
    --cc=linux-nfs@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).