From: Benno Schulenberg Date: Sun, 27 Jul 2014 18:58:58 +0000 (+0200) Subject: docs: improve the formatting of the chfn and chsh man pages X-Git-Tag: v2.26-rc1~567 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=bf967a6cabc782dd7fd0ed8a2f8ea4d3ad0dae2f;p=thirdparty%2Futil-linux.git docs: improve the formatting of the chfn and chsh man pages Also fix a pasting mistake where the chfn man page suggested to use ypchsh or lchsh for non-local entries. Signed-off-by: Benno Schulenberg --- diff --git a/login-utils/chfn.1 b/login-utils/chfn.1 index 3b44fb3680..564fed3019 100644 --- a/login-utils/chfn.1 +++ b/login-utils/chfn.1 @@ -2,15 +2,11 @@ .\" chfn.1 -- change your finger information .\" (c) 1994 by salvatore valente .\" -.\" this program is free software. you can redistribute it and -.\" modify it under the terms of the gnu general public license. -.\" there is no warranty. +.\" This program is free software. You can redistribute it and +.\" modify it under the terms of the GNU General Public License. +.\" There is no warranty. .\" -.\" $Author: faith $ -.\" $Revision: 1.1 $ -.\" $Date: 1995/03/12 01:29:16 $ -.\" -.TH CHFN 1 "July 2009" "util-linux" "User Commands" +.TH CHFN 1 "July 2014" "util-linux" "User Commands" .SH NAME chfn \- change your finger information .SH SYNOPSIS @@ -38,40 +34,40 @@ program. The Linux command will display four pieces of information that can be changed by .BR chfn : your real name, your work room and phone, and your home phone. - -.B chfn -supports non-local entries (kerberos, LDAP, etc.\&) if linked with libuser, -otherwise use ypchsh, lchsh or any other implementation for non-local -entries. -.SS COMMAND LINE +.PP Any of the four pieces of information can be specified on the command line. If no information is given on the command line, .B chfn enters interactive mode. -.SS INTERACTIVE MODE +.PP In interactive mode, .B chfn will prompt for each field. At a prompt, you can enter the new information, or just press return to leave the field unchanged. Enter the keyword "none" to make the field blank. +.PP +.B chfn +supports non-local entries (kerberos, LDAP, etc.\&) if linked with libuser, +otherwise use \fBypchfn\fR, \fBlchfn\fR or any other implementation for +non-local entries. .SH OPTIONS .TP -.BI "\-f, \-\-full-name " full-name +.BR \-f , " \-\-full-name " \fIfull-name Specify your real name. .TP -.BI "\-o, \-\-office " office +.BR \-o , " \-\-office " \fIoffice Specify your office room number. .TP -.BI "\-p, \-\-office-phone " office-phone +.BR \-p , " \-\-office-phone " \fIoffice-phone Specify your office phone number. .TP -.BI "\-h, \-\-home-phone " home-phone +.BR \-h , " \-\-home-phone " \fIhome-phone Specify your home phone number. .TP -.B "\-u, \-\-help" +.BR \-u , " \-\-help" Display help text and exit. .TP -.B "\-v, \-\-version" +.BR \-v , " \-\-version" Display version information and exit. .SH "EXIT STATUS" Returns 0 if operation was successful, 1 if operation failed or command syntax was not valid. diff --git a/login-utils/chsh.1 b/login-utils/chsh.1 index 229f5e1498..eb59c5c067 100644 --- a/login-utils/chsh.1 +++ b/login-utils/chsh.1 @@ -2,15 +2,11 @@ .\" chsh.1 -- change your login shell .\" (c) 1994 by salvatore valente .\" -.\" this program is free software. you can redistribute it and -.\" modify it under the terms of the gnu general public license. -.\" there is no warranty. +.\" This program is free software. You can redistribute it and +.\" modify it under the terms of the GNU General Public License. +.\" There is no warranty. .\" -.\" $Author: faith $ -.\" $Revision: 1.1 $ -.\" $Date: 1995/03/12 01:28:58 $ -.\" -.TH CHSH 1 "July 2009" "util-linux" "User Commands" +.TH CHSH 1 "July 2014" "util-linux" "User Commands" .SH NAME chsh \- change your login shell .SH SYNOPSIS @@ -30,22 +26,22 @@ prompts for one. .B chsh supports non-local entries (kerberos, LDAP, etc.\&) if linked with libuser, -otherwise use ypchsh, lchsh or any other implementation for non-local -entries. +otherwise use \fBypchsh\fR, \fBlchsh\fR or any other implementation for +non-local entries. .SH OPTIONS .TP -.BI "\-s, \-\-shell " shell +.BR \-s , " \-\-shell " \fIshell Specify your login shell. .TP -.B "\-l, \-\-list-shells" +.BR \-l , " \-\-list-shells" Print the list of shells listed in .I /etc/shells and exit. .TP -.B "\-u, \-\-help" +.BR \-u , " \-\-help" Display help text and exit. .TP -.B "\-v, \-\-version" +.BR \-v , " \-\-version" Display version information and exit. .SH "VALID SHELLS" .B chsh