Commit Graph

99 Commits

Author SHA1 Message Date
Michael Meffie
55945926f9 scout: adjustable column widths
Adds new command line option to scout so users can set the
number of characters to display without truncating.

Change-Id: I69f159549d7f5b4cfee26c276ad34705f504ee2b
Reviewed-on: http://gerrit.openafs.org/1951
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Russ Allbery <rra@stanford.edu>
Tested-by: Russ Allbery <rra@stanford.edu>
2010-05-26 07:58:36 -07:00
Russ Allbery
48d3ec164b Update fs {get,set}serverprefs documentation for DNS
Mention in the fs getserverprefs and fs setserverprefs documentation
that VL servers may also come from DNS AFSDB and SRV records.  Document
that SRV record information is not (yet) properly used.

Change-Id: I223efedf4d00ac1b57b3dce74a807790691abdbf
Reviewed-on: http://gerrit.openafs.org/2015
Tested-by: Russ Allbery <rra@stanford.edu>
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2010-05-24 20:23:49 -07:00
Michael Meffie
5e09bcd936 pts mem -expandgroups and -supergroups examples
Examples of the pts mem -expandgroups and -supergroups
options for the man page.

Change-Id: Idea0509797212397eff87aa5975eaf5364c8414c
Reviewed-on: http://gerrit.openafs.org/1896
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-05-03 17:04:17 -07:00
Russ Allbery
e6f6c3493e Fixes and clarifications to vos setaddrs man page
Add a caution explaining how the file server addresses are registered
and pointing users at NetInfo and NetRestrict plus restarting the file
server for the normal case.

Mention what version of OpenAFS introduced this command.  Drop the note
about the version of OpenAFS that added the -encrypt flag, since the
whole command is newer than that.

Reference vos listaddrs -printuuid specifically to get the UUID.

General formatting and wording cleanup: use terminology more consistently,
continue a long example line, wrap long lines, fix a spelling error, and
add cross-references to NetInfo and NetRestrict.

Change-Id: Idd6175339dc0feb1b777963bbb09731e42b83522
Reviewed-on: http://gerrit.openafs.org/1787
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-04-19 20:24:11 -07:00
Harald Barth
2a35e3a028 Add vos setaddrs command and man page
The vos setaddrs command sets the IP addresses for a server entry
in the Volume Location Database (VLDB). Specify one or serveral hosts.
All existing hosts in the VLDB entry are replaced with the new entries
on the command line.

Change-Id: I3c26e49c4a6e2aebae363017d074329ac265132a
Reviewed-on: http://gerrit.openafs.org/1744
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-04-16 10:15:29 -07:00
Michael Meffie
f2af7a6ffc pts mem -expandgroups option
Improve support for supergroups in the pts membership command
with a new option called -expandgroups. This option will
recursively show the complete membership of users and groups.
The expanded members of a group are all the users which are
members of all of the group's sub-groups.  The expanded groups
of a user are all the groups which are supergroups of the
users's groups.

Change-Id: I811a4e5e73632e5e205fe10f3f3a36a98464d49e
Reviewed-on: http://gerrit.openafs.org/1601
Reviewed-by: Andrew Deason <adeason@sinenomine.net>
Tested-by: Andrew Deason <adeason@sinenomine.net>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-04-08 11:23:34 -07:00
Michael Meffie
5b44b5dfe0 pts mem -supergroup option
Improve pts support for supergroups with an option to list the
supergroups of a group.

Change-Id: I4fe1cd131cd334386bc16ce733e01e29e0511d4f
Reviewed-on: http://gerrit.openafs.org/1600
Reviewed-by: Andrew Deason <adeason@sinenomine.net>
Tested-by: Andrew Deason <adeason@sinenomine.net>
Reviewed-by: Simon Wilkinson <sxw@inf.ed.ac.uk>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-04-08 11:23:26 -07:00
Simon Wilkinson
61af204cf3 Document the extra options to fs getcacheparms
Write some documentation for the -files and -excessive options to
fs getcacheparms

Change-Id: I769f8c0cf6d9d100a1687ae73a337132befb2449
Reviewed-on: http://gerrit.openafs.org/1217
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-02-03 07:53:24 -08:00
Russ Allbery
1526593621 Correct spelling errors in man pages
Correct several spelling errors in the man pages detected by Debian's
Lintian package checking tool.

Change-Id: I3834a12776ec5e27b04d80fbfcc43ffe71cf1790
Reviewed-on: http://gerrit.openafs.org/1051
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2009-12-31 05:09:40 -08:00
Simon Wilkinson
acd1bcf726 Documentation: vos dump -verbose outputs to stderr
vos dump -verbose sends its logging to stderr, not to stdout (where
it would potentially collide with the dump data itself).

FIXES 124911

Change-Id: I515c50df59d2f376787969df59b6e01e244ecbc7
Reviewed-on: http://gerrit.openafs.org/1044
Reviewed-by: Russ Allbery <rra@stanford.edu>
Tested-by: Russ Allbery <rra@stanford.edu>
2009-12-29 17:11:26 -08:00
Andrew Deason
3df80a1638 Add the 'vos endtrans' command
Add a command to vos to explicitly end volume transactions. These can
happen if (for example) we segfault or the user ctrl-C's in 'vos'
before/after a volume operation, but before we AFSVolEndTrans.

Change-Id: Ie34ee1fdff917b56900f456c7cf8b1329533a7da
Reviewed-on: http://gerrit.openafs.org/870
Reviewed-by: Dan Hyde <drh@umich.edu>
Reviewed-by: Alistair Ferguson <alistair.ferguson@mac.com>
Tested-by: Alistair Ferguson <alistair.ferguson@mac.com>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2009-12-16 10:57:07 -08:00
Andrew Deason
9bd7256927 Formatting typos in pts.pod
Fix a couple of B<...> sequences pod2man yells at us about.

Reviewed-on: http://gerrit.openafs.org/649
Tested-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Russ Allbery <rra@stanford.edu>
2009-10-12 12:08:59 -07:00
Davor Ocelic
923721f839 Minimal left docs updates for vos suite
Reviewed-on: http://gerrit.openafs.org/615
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-10-08 15:24:40 -07:00
Andrew Deason
eb46f02e56 Typo in vos_remsite.pod
A typo in c717fcd32c removed the = before
the first head1 in vos_remsite.pod. Put it back.

Reviewed-on: http://gerrit.openafs.org/612
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-10-08 13:23:24 -07:00
Davor Ocelic
065d9a65ba Add POD links (L<>) in pts.pod and symlink.pod
Reviewed-on: http://gerrit.openafs.org/610
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-10-08 11:00:14 -07:00
Davor Ocelic
c717fcd32c Update vos suite manpages
Larger collection of all vos suite commands, including but
not limited to:

 -- documented all commands / options, verified against both 1.4 and 1.5 tree
    (including the common -encrypt/-noresolve options)

 -- correct order, POD formatting and synopsis for all commands' options

 -- shorthand synopsis provided for all commands that missed it, with proper
    non-ambiguous command abbreviations of all options

 -- POD synopsis formatted to 80-columns in commands where it was running over

 -- for newer options, documented which OpenAFS version they became available

 -- proper manpage links using L<> in vos.pod

Reviewed-on: http://gerrit.openafs.org/609
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-10-08 10:59:20 -07:00
Jeffrey Altman
e74f819555 documentation for "fs listacl -cmd"
LICENSE BSD

Reviewed-on: http://gerrit.openafs.org/586
Reviewed-by: Matt Benjamin <matt@linuxbox.com>
Reviewed-by: Hartmut Reuter <reuter@rzg.mpg.de>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Tested-by: Jeffrey Altman <jaltman@openafs.org>
2009-10-06 13:39:52 -07:00
Andrew Deason
fee0efedc1 Formatting typo in vos_setfields manpage
The POD formatting code for bold is B, not b.

Reviewed-on: http://gerrit.openafs.org/546
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-09-28 08:25:25 -07:00
Russ Allbery
d6df1a8cec Move restorevol to bin from sbin
restorevol only requires access to a dump file and write access to the
directory in which the dump is being unpacked.  It doesn't require being
a superuser, so it should be installed in bin instead of sbin.  Also
move the man page to section 1 and update references accordingly.

Reviewed-on: http://gerrit.openafs.org/333
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2009-09-09 21:22:34 -07:00
Russ Allbery
da0673f0ea Describe 's' PTS group permissions more accurately
PTS groups with 's' access permissions can be examined by members of the
group and the owner of the group in addition to system:administrators.
State this in the manual page.

Reviewed-on: http://gerrit.openafs.org/327
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-08-20 12:11:13 -07:00
Russ Allbery
55b8a4d35e Document human-readable size suffixes
Document that the quotas passed to fs setquota, vos create, and vos
setfields and the size passed to fs setcachesize may take a suffix
indicating the unit.  This documents the change in behavior implemented by
54c0a3f3e6.

Fix a copy/paste error in the vos create -maxquota option definition.

Reviewed-on: http://gerrit.openafs.org/212
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-07-25 07:10:52 -07:00
Andrew Deason
29a5ddf1dd Allow specifying vos create/addsite volume IDs
This adds the -id option to 'vos create', and the -roid option to 'vos
create' and 'vos addsite'. This allows the user to manually specify the
volume IDs that a new RW or RO volume will get (or explicitly specify
that an RO volume ID should be unset), instead of always relying on the
volume IDs retrieved from the vlserver.

Reviewed-on: http://gerrit.openafs.org/157
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-07-24 12:29:30 -07:00
Simon Wilkinson
c321cb4672 Rename installed version of compile_et
Rename the installed version of compile_et to afs_compile_et to avoid
conflicts with other, more standard, users of com_err. Also rename the
man page to match

Reviewed-on: http://gerrit.openafs.org/http://gerrit.openafs.org/175
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-07-23 10:44:43 -07:00
Andrew Deason
722070a5c6 Correcting formatting typo in vos addsite manpage
Reviewed-on: http://gerrit.openafs.org/12
Verified-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Russ Allbery <rra@stanford.edu>
2009-07-08 15:27:35 -06:00
Andrew Deason
7488aeef5c Fixing manpage for vos addsite -valid
The -valid switch to vos addsite doesn't take an argument, and it is
optional. Correcting documentation to reflect that.

Reviewed-on: http://gerrit.openafs.org/11
Verified-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Russ Allbery <rra@stanford.edu>
2009-07-08 15:18:03 -06:00
Jason Edgecombe
002363adb9 Fixed a minor grammatical error in the voz_zap man page
Reviewed-on: http://gerrit.openafs.org/7
Verified-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Russ Allbery <rra@stanford.edu>
2009-07-06 19:47:03 -06:00
Jeffrey Altman
4db337f87c manpages-fs-chown-chgrp-20090701
LICENSE BSD

Add new man pages for fs chown and chgrp on Windows.

Update titles for Windows only commands to indicate they are Windows only.
2009-07-01 22:12:10 +00:00
Mike Meffie
394243f3ae man-page-xstat-fs-test-20090608
LICENSE IPL10
FIXES 124905

Document xstat_fs_test collection 3, which returns callback statistics
from the file server (useful for tuning).
2009-06-08 23:39:51 +00:00
Russ Allbery
4c7a7f343c man-page-vos-dump-flags-20090526
LICENSE BSD

Add documentation of the -clone and -omitdirs flags to vos dump.
2009-05-27 02:21:45 +00:00
Russ Allbery
9ad6c37ccf man-page-syntax-errors-20090518
LICENSE BSD

Fix some man page syntax errors that snuck into the recent round of
updates.
2009-05-19 00:53:26 +00:00
Steven Jenkins
798ffe54af man-page-krb-varients-20090518
FIXES 124799
LICENSE IPL10

Install symlinks for the *.krb versions of klog, pagsh, and tokens to the
non-krb versions and add information about the *.krb versions to the
non-krb man pages.
2009-05-18 23:22:29 +00:00
Steven Jenkins
97b0d23014 man-page-restorevol-20090518
LICENSE IPL10
FIXES 124791

Add man page for restorevol.
2009-05-18 19:46:33 +00:00
Steven Jenkins
01ba5ab1ed man-page-fs-monitor-20090518
LICENSE IPL10
FIXES 124790

Add man page for fs monitor.
2009-05-18 19:35:31 +00:00
Steven Jenkins
a7a80efd57 man-page-copyauth-20090518
FIXES 124789
LICENSE IPL10

Add man page for copyauth.
2009-05-18 19:32:06 +00:00
Steven Jenkins
16ec87e0b3 man-page-compile-et-20090518
LICENSE IPL10
FIXES 124788

Add man page for compile_et.
2009-05-18 19:28:05 +00:00
Mike Robinson
faf518ace7 man-page-yet-more-fs-commands-20090517
LICENSE IPL10
FIXES 109189

Add new man pages for fs rxstatproc, fs setcbaddr, and fs trace.  Also
updates the links from fs to its subsidiary man pages and fixes the
fs rxstatpeer man page a bit to mirror fs rxstatproc.
2009-05-18 04:34:38 +00:00
Steven Jenkins
32c93cf552 man-page-more-fs-commands-20090517
LICENSE IPL10
FIXES 124756

Add man pages for fs cscpolicy, fs getfid, and fs memdump.
2009-05-18 03:50:00 +00:00
Derrick Brashear
6ba44802ea pts-encrypt-option-20090512
LICENSE IPL10
FIXES 124681

add -encrypt flag to pts generic options, allowing the wire to be
encrypted if desired and the user's authenticated. document same.
2009-05-12 20:40:20 +00:00
Jason Edgecombe
85bb464bb4 man-page-vos-setfields-20090316
LICENSE BSD
FIXES 124472

New man page for vos setfields.  Also adds -noresolve documentation to the
vos(1) common flags.
2009-03-17 02:21:14 +00:00
Russ Allbery
f204e4e37f man-page-vos-examine-copy-date-20090201
LICENSE BSD

Document the Copy field of vos examine output.
2009-02-02 01:12:02 +00:00
Jason Edgecombe
8c18c62dff man-page-pts-membership-fixes-20090119
FIXES 124157
LICENSE BSD

More wording and typo fixes for the pts membership man page.
2009-01-19 23:02:36 +00:00
Russ Allbery
d781450cf3 man-page-pts-membership-privilege-20090118
FIXES 124151
LICENSE BSD

Add system:ptsviewers to the privilege documentation of pts membership and
try to clarify the privilege required by being less verbose and hopefully
more direct.
2009-01-19 03:09:52 +00:00
Derrick Brashear
4119d9742b syncserv-syncvldb-manpages-dryrun-20080906
LICENSE IPL10

make syncserv and syncvldb manpages reflect dryrun option
2008-09-06 12:51:01 +00:00
Jason Edgecombe
298fb5ce52 docs-ticket-104110-20080713
LICENSE BSD
FIXES 104110

add vos clone and vos shadow to overall list

====================
This delta was composed from multiple commits as part of the CVS->Git migration.
The checkin message with each commit was inconsistent.
The following are the additional commit messages.
====================
LICENSE BSD
FIXES 104110

add krb.conf

update CellServDB to discuss AFSDB DNS records
2008-07-14 00:51:35 +00:00
Jason Edgecombe
c766e74fd6 docs-max-part-size-20080713
LICENSE BSD
FIXES 86677

remove discussion of max partition size now that 1.5 has a limit of 2^64 KB.

add discussion of techinical nature of fs minidump on windows.

====================
This delta was composed from multiple commits as part of the CVS->Git migration.
The checkin message with each commit was inconsistent.
The following are the additional commit messages.
====================
LICENSE BSD
FIXES 86677

update discussion of max partition size.
2008-07-14 00:33:59 +00:00
Jeffrey Altman
df9f2455fb man-page-fs-read-not-list-20080711
LICENSE MIT

 - fs diskfree
 - fs examine
 - fs listquota
 - fs quota

require read permission not list for the root directory
of the volume and list permission for the preceding path.
2008-07-12 06:54:58 +00:00
Russ Allbery
6331d37125 man-page-vos-convertROtoRW-inode-20080630
LICENSE BSD

vos convertROtoRW can now be used with an inode file server.  Adjust the
man page accordingly.
2008-06-30 20:49:19 +00:00
Russ Allbery
3b273dd552 install-and-document-klog-krb5-20080627
LICENSE IPL10

Install the Kerberos v5 klog as klog.krb5 and install a man page for it.
2008-06-28 06:19:22 +00:00
Jason Edgecombe
e381e1d078 man-page-afs-fixes-20080626
FIXES 104745
LICENSE BSD

Fix several issues with the afs(1) man page.  Based on the patch by Jason,
but I also documented /vicepiv as the maximum, and /vicepiu as the
maximum recommended, partition.
2008-06-27 04:49:45 +00:00
Jason Edgecombe
fbe10c8086 man-page-vos-clone-20080626
FIXES 104110
LICENSE BSD

Add man page for vos clone.
2008-06-27 04:19:07 +00:00