Commit Graph

162 Commits

Author SHA1 Message Date
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
Davor Ocelic
dde6f7d840 Allow check-pod to work on specific files or dirs
Reviewed-on: http://gerrit.openafs.org/608
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-10-08 10:55:57 -07:00
Davor Ocelic
f387806bd4 Update readme with solved and pending tasks
Reviewed-on: http://gerrit.openafs.org/611
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-10-08 10:51:29 -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
fdea6a3418 Windows: update build system for restorevol man page move
restorevol moved from section 8 to section 1.  The Windows build
system needed corresponding changes.

Reviewed-on: http://gerrit.openafs.org/440
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-09-10 11:06:04 -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
5dd137c474 Turn on --enable-bos-new-config unconditionally
Remove the conditional and Autoconf flag for enabling BosConfig.new
handling and change bosserver to always rename BosConfig.new to BosConfig
on startup if the former exists.

Document BosConfig.new handling in the bosserver and BosConfig man pages.
Tone down the warning about the BosConfig file format changing and warn
that bosserver rewrites BosConfig when shutting down.

Reviewed-on: http://gerrit.openafs.org/211
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2009-09-01 09:46:37 -07:00
Michael Meffie
8540814140 doc: typo fix in asetkey man page example
Fixed a typo in the asetkey man page.

Reviewed-on: http://gerrit.openafs.org/373
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-08-28 11:30:49 -07:00
Jeffrey Altman
a767455f02 Correct description of afs krb.conf file format
The file format is a single line containing one or more realms
separated by white space.

LICENSE BSD

Reviewed-on: http://gerrit.openafs.org/352
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2009-08-27 13:15:05 -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
5a4f31090f Restore permission documentation in bosserver man page
The original IBM HTML documentation had a table showing the permissions
that bosserver expects and sets when it creates the directory structure
for AFS.  That table was accidentally dropped in the conversion to POD.
Restore it from the HTML shipped with an older version of OpenAFS.

Reviewed-on: http://gerrit.openafs.org/210
Tested-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Russ Allbery <rra@stanford.edu>
2009-07-31 15:07:49 -07:00
Jason Edgecombe
38a641bd6b Future-proof the wording of the auditlog options in the man pages
It was suggested that the auditlog option should not say there is one
record per RPC. In the future, there might be a need for multiple records
per RPC.

LICENSE BSD

Reviewed-on: http://gerrit.openafs.org/229
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-07-26 18:59:21 -07:00
Jason Edgecombe
e3b7fa7a1e Expanded the -auditlog entries in the man pages of the server processes
The expanded auditlog explanation includes what information is recorded
in the auditlog.

LICENSE BSD

Reviewed-on: http://gerrit.openafs.org/213
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-07-25 18:02:46 -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
7b0b6a0ce9 Enhance audit logs to support SysV message queues
Adds support for sysv message queues for fileserver audit logs. This
also organizes the audit log code into various 'interfaces', of which
there are two: the original 'file' interface, and the 'sysvmq' interface
that this adds. The interface is configurable at runtime with the
-audit-interface switch.

FIXES 124674

Reviewed-on: http://gerrit.openafs.org/82
Tested-by: Andrew Deason <adeason@sinenomine.net>
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-07-24 12:39:57 -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
Jeffrey Altman
ab27eb24af Windows: rename compile_et.pod to afs_compile_et.pod
Gerrit 175 renamed compile_et and compile_et.pod to afs_compile_et*.
Fix the Windows build system to process the new pod file name
and modify the WiX installer scripts to install afs_compile_et.html.

FIXES 125152

LICENSE MIT

Reviewed-on: http://gerrit.openafs.org/http://gerrit.openafs.org/204
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-07-23 13:48:25 -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
Simon Wilkinson
d5081f264d Remove CVS ignore files
Now we're in git we don't need any cvsignore files any more...

Reviewed-on: http://gerrit.openafs.org/1
Verified-by: Derrick Brashear <shadow@gmail.com>
Reviewed-by: Derrick Brashear <shadow@gmail.com>
2009-07-06 11:03:16 -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
Simon Wilkinson
c41a467741 gitignore-20090615
LICENSE IPL10

make gitignore files
2009-06-15 23:29:29 +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
Jeffrey Altman
5bd88cfa6b doc-man-pages-windows-20090607
LICENSE MIT

dpass and package docs removed from repository.
do not attempt to build them.
2009-06-08 03:08:33 +00:00
Derrick Brashear
6d973e499a man-page-cellservdb-extras-20090605
LICENSE IPL10

Document linked cells and non-voting replicas in the CellServDB man page
and note the need for better linked cell documentation.
2009-06-05 19:17:13 +00:00
Derrick Brashear
4af75fe96a curpag-via-pioctl-20090603
LICENSE IPL10
FIXES 124709

curpag needs to know about kernel constructs (getpagvalue on AIX, onegroup
versus two group on linux) and on aix 5.1 simply can't work. add a new pioctl
and use it to simply ask the kernel what the current pag is
2009-06-03 06:39:47 +00:00
Russ Allbery
3ae35e1271 doc-man-page-install-variables-20090602
LICENSE BSD

We were horribly confused about variables when creating man page symlinks.
Be less confused by using variables less.
2009-06-02 18:31:32 +00:00
Douglas Engert
74df876daf afsd-allow-maxmtu-override-20090530
LICENSE IPL10
FIXES 124880

rxi_Findcbi, rxi_FIndIfnet, rxi_FindIfMTU "failure" end up returning
the RX_REMOTE_PACKET_SIZE as the mtu to use unless we allow our override
to apply, so we do that. then, add an afsd switch to allow setting it.

afsd man page update required and will follow.

====================
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 IPL10
FIXES 124880

man page update to document previous work
2009-05-31 02:22:24 +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
Jeffrey Altman
4a523957fe windows-doc-man-dependency-20090525
LICENSE IPL10

html\index.html not index.html
2009-05-26 00:53:53 +00:00
Jeffrey Altman
d8410b56c8 windows-doc-man-makefile-20090525
LICENSE IPL10

Add a proper dependency list so that the man-pages are not
rebuilt when no changes have occurred.
2009-05-25 21:00:18 +00:00
Derrick Brashear
6cc155e8da krb-conf-manpage-path-fix-20090519
LICENSE IPL10

fix path to krb.conf, per IRC discussion
2009-05-19 19:40:09 +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
6df6046813 man-page-cellservdb-updates-20090518
FIXES 124794
LICENSE IPL10

Note in CellServDB man page that it's also used to populate root.afs for
a -dynroot client.  Also document the dynamic lookup of database servers
with -afsdb and provide some more information about when CellServDB has to
contain the cell and when it doesn't.

Mark the backup server as optional, and indicate that the authentication
server is deprecated and CellServDB isn't required for authentication if
Kerberos v5 and aklog are used.
2009-05-18 21:42:26 +00:00
Steven Jenkins
1df9282985 man-page-vsys-20090518
LICENSE BSD
FIXES 124793

Add man page for vsys.
2009-05-18 21:28:26 +00:00
Steven Jenkins
921774594f man-page-rmtsysd-20090518
LICENSE IPL10
FIXES 124792

New man page for rmtsysd.
2009-05-18 21:22:04 +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
Simon Wilkinson
d5c2efa499 man-pod-fileserver-20090515
LICENSE IPL10
FIXES 124778

-L sets the max number of threads
2009-05-15 14:30:07 +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