Commit Graph

748 Commits

Author SHA1 Message Date
Jason Edgecombe
9c32ac52f1 Quickstart guide: use yum install from openafs repo
Change-Id: Icd8b3c2a60e2cd751da00056cfc3e11e90472ec6
Reviewed-on: http://gerrit.openafs.org/3159
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-10-26 15:18:11 -07:00
Phillip Moore
f1a0239fba Added missing CLI argument dropped during last commit.
Oops -- when removing the -cell arguments to the bos commands, the
"admin" username argument to "bos adduser" was mistakenly removed as
well.

Change-Id: If5136869c7d2bff3340018a3110fd5408750e5a6
Reviewed-on: http://gerrit.openafs.org/2940
Reviewed-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-10-05 23:27:02 -07:00
Phillip Moore
51c761706a Quick Start Guide updated for RHEL rpms, and CLI syntax
The names of the RHEL rpms have been updated to reflect what is
actually published on openafs.org, and the CLI syntax of the commands
run using -noauth have had the unnecessary -cell options removed.

Change-Id: I5c03d371c822d1d064660a3b00fb3d1e64bff141
Reviewed-on: http://gerrit.openafs.org/2914
Reviewed-by: Russ Allbery <rra@stanford.edu>
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2010-10-05 12:30:01 -07:00
Chas Williams (CONTRACTOR)
2bcd9044f7 afsd's -mem_alloc_sleep is obselete -- update documentation
to reflect this.

Change-Id: Ife0f4a2582fe535d7c977d0ca24f92e314459386
Reviewed-on: http://gerrit.openafs.org/2874
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-09-30 12:06:54 -07:00
Andrew Deason
7e12632cd2 DAFS: document the limits of -vhashsize
You can only specify a -vhashsize between 6 and 28 (inclusive).
Document that in the dafileserver man page.

Change-Id: I44d1c71f4ff303174e8aebf74b0b9075c07bc8b4
Reviewed-on: http://gerrit.openafs.org/2650
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-09-30 06:28:49 -07:00
Russ Allbery
68d074d8aa Link dafssync-debug(8) to fssync-debug(8)
The two commands are documented identically for right now, so just link
the dafssync-debug man page to the fssync-debug man page.  Remove the
incorrect statement in the man page that fssync-debug only works with
demand-attach.

FIXES 128166

Change-Id: I812641ad7a345c7f5412c3c97ed1ba393e981639
Reviewed-on: http://gerrit.openafs.org/2836
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-09-23 02:22:44 -07:00
Russ Allbery
10281b5be2 Fix POD errors in fileserver and dasalvager
Fix missing newlines before =back commands.

Change-Id: If8e65c94f48c271c37c1b4bbec1b17d383c8375d
Reviewed-on: http://gerrit.openafs.org/2831
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-09-23 02:21:51 -07:00
Russ Allbery
82b7327b5b Update bos create man page for new naming of demand-attach binaries
The demand-attach fileserver binaries now have a "da" prefix.  Adjust
the documentation in the man page for bos create accordingly, and add
the new binaries to SEE ALSO.

Change-Id: Ib70bad87aaf8bfc483ffbfe402db01c178e6c4e4
Reviewed-on: http://gerrit.openafs.org/2830
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-09-23 02:19:00 -07:00
Russ Allbery
089cd2c103 Mention KRB5CCNAME in the aklog man page
AFS users not otherwise familiar with Kerberos may not realize that
one sets KRB5CCNAME to use an alternative ticket cache.  Mention the
variable in the aklog man page, although defer to the Kerberos
documentation for most details.

Change-Id: I13133285f153f86e0aa1e95b24715e01d576075d
Reviewed-on: http://gerrit.openafs.org/2761
Reviewed-by: Andrew Deason <adeason@sinenomine.net>
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Rod Widdowson <rdw@steadingsoftware.com>
Reviewed-by: Russ Allbery <rra@stanford.edu>
2010-09-20 14:10:08 -07:00
Michael Meffie
92ff0028f2 manpage correction for restorevol -file option
The restorevol -file option specifies which file to read.

Change-Id: I5c03eaaf8bf82fc6d3fb83ff08e8278257e7b65f
Reviewed-on: http://gerrit.openafs.org/2728
Reviewed-by: Andrew Deason <adeason@sinenomine.net>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-09-09 13:12:32 -07:00
Jeffrey Altman
99811e3e5f Windows: 1.5.77 Change Log summary
Change-Id: Ic0362956470ddb76fac64d21927b3e51b7980ea6
Reviewed-on: http://gerrit.openafs.org/2710
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Tested-by: Jeffrey Altman <jaltman@openafs.org>
2010-09-07 11:36:42 -07:00
Jeffrey Altman
523fde4398 Windows Change Log for 1.5.76
Change-Id: Ia5004d37fceb506ed7ca894f31a903d2b8cb66cb
Reviewed-on: http://gerrit.openafs.org/2540
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2010-08-16 12:36:26 -07:00
Andrew Deason
d0080e261c Add DAFS docs to the Unix Quick Start guide
Modify the sections dealing with creating the 'fs' bnode to also
mention how to create the 'dafs' bnode, and add an appendix explaining
DAFS and the differences between DAFS and non-DAFS.

Change-Id: I026405dbc3838a9a0247b85cbdc508d6be93275d
Reviewed-on: http://gerrit.openafs.org/2508
Tested-by: Andrew Deason <adeason@sinenomine.net>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-08-04 13:18:54 -07:00
Jason Edgecombe
9ec343cf42 Factor out the common text in vos_addsite, vos_copy, and vos_zap
Factor out some common options out of the man pages.

LICENSE IPL

Change-Id: Ic79e53a2d6464cc62d49987ab58d38c9898f372b
Reviewed-on: http://gerrit.openafs.org/2496
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-08-02 08:46:17 -07:00
Asanka Herath
78dcbd11d4 Windows: Build preprocessed POD documentation
Change-Id: I0b849bf52094a1b6ca0e45db5e2f92ff58b8efba
Reviewed-on: http://gerrit.openafs.org/2493
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-08-02 08:37:07 -07:00
Asanka Herath
cf0d7fea04 Skip over 'fragments' directory when scanning for PODs
The generate-html script scans the directories to compile a list of
POD files.  The list of candidates include the 'fragments' directory,
which causes an error when the script attempts to open it as a file.

Change-Id: If1208561f58f869ccba60f4a263bee5200dad1ed
Reviewed-on: http://gerrit.openafs.org/2494
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Russ Allbery <rra@stanford.edu>
Tested-by: Russ Allbery <rra@stanford.edu>
2010-08-01 07:14:57 -07:00
Andrew Deason
429feee73d Document krb.excl
Change-Id: I0ac49b6d705190f877f6b09b69a3efe24b5c3d8e
Reviewed-on: http://gerrit.openafs.org/2487
Tested-by: Andrew Deason <adeason@sinenomine.net>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-07-30 18:56:07 -07:00
Andrew Deason
ea8be82b95 Document the 'vos offline' -busy and -sleep opts
Change-Id: I68d374a206a398467e5980a87b3ca2ad41bf9653
Reviewed-on: http://gerrit.openafs.org/2482
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-07-29 11:41:54 -07:00
Andrew Deason
11854c734a Remove bless-related options from vos manpages
'vos online' and 'vos offline' were documented as taking -bless and
-unbless options, respectively. They do not actually take these
options, and since adding that functionality, while useful, will
require protocol changes, they are likely to take some time to appear.

Change-Id: I91800e9637162e24873beac5d41f3ad456f25af8
Reviewed-on: http://gerrit.openafs.org/2481
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-07-29 11:30:14 -07:00
Russ Allbery
41d321e900 Don't cd around invocations of install-man
install-man is a config.status-generated script, so Autoconf will
substitute in the path to our install-sh script, but Autoconf prefers
relative paths that are only valid in the directory in which
install-man is generated.  We therefore must avoid changing directories
before calling install-man.

Instead of cd, use relative paths including the directory and adjust
the installation path accordingly.

Change-Id: I8666257b9d74fa80cf7f136bd0ee6ff895897066
Reviewed-on: http://gerrit.openafs.org/2460
Reviewed-by: Andrew Deason <adeason@sinenomine.net>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-07-21 11:29:30 -07:00
Derrick Brashear
9c9b4bb827 document dasalvager
split dasalvager and salvager documentation.
refer both ways between docs.

Change-Id: I33480cae671c3f50d47a5a4f8407a07f268164a1
Reviewed-on: http://gerrit.openafs.org/2442
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-07-18 09:46:48 -07:00
Derrick Brashear
6f29ed951f document davolserver
split davolserver and volserver documentation.
refer both ways between docs.

Change-Id: Iac70ac8e1fb8bfcb7ebfdbed8e9d7870a2e69fee
Reviewed-on: http://gerrit.openafs.org/2441
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-07-18 09:42:30 -07:00
Derrick Brashear
214f8ea022 dafileserver synopsis
missed this before, needed for dafs man page

Change-Id: Ie9a309995638ea315198ea204cbc16e2cdc3fbe7
Reviewed-on: http://gerrit.openafs.org/2447
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-07-18 08:46:21 -07:00
Derrick Brashear
c15a8c65ad document dafileserver
split dafileserver and fileserver documentation. remove dafs-only
switches from fileserver doc. refer both ways between docs.

Change-Id: Ibcac8ed3f294c18436978f3cd4e52de305130198
Reviewed-on: http://gerrit.openafs.org/2425
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-07-18 08:43:22 -07:00
Andrew Deason
48758397ae vos status: add lastActiveTime field
Add a field in the 'vos status' output to report the last time a
transaction was touched by a volser RPC.

Change-Id: Ibfe11e16fc3d7f00134d840ec3ab9fb9263fbea1
Reviewed-on: http://gerrit.openafs.org/2337
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2010-07-18 08:20:41 -07:00
Russ Allbery
a792acdadc Add include method for POD documentation
Add a preprocessor for POD documentation that handles a custom
=include directive.  Demonstrate how to use the preprocessor by
factoring out all the standard PTS options into a separate POD
fragment and including that fragment in all the PTS commands that
take the standard options instead of including that documentation
in each separate file.

Change-Id: If5255efc6d3fc670b38a9898b3d7d3c60af04fcf
Reviewed-on: http://gerrit.openafs.org/2440
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-07-15 21:09:13 -07:00
Russ Allbery
3e2c3c9a56 Fix unterminated B<> sequence in bos addhost man page
Change-Id: Ied06fbf8c0a9cc064b257daf6272cd5a5bd2e816
Reviewed-on: http://gerrit.openafs.org/2439
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-07-15 21:07:35 -07:00
Michael Meffie
a658736af6 man: document bos addhost -clone
Add the missing -clone option to the bos addhost
man page.

Change-Id: I0ead9acfd25d573b907f2617845c25c8c11df53c
Reviewed-on: http://gerrit.openafs.org/2349
Tested-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Russ Allbery <rra@stanford.edu>
2010-07-14 11:18:14 -07:00
Andrew Deason
eae0fe48b9 Add -unsafe-nosalvage fileserver option
Provide a runtime flag to the DAFS fileserver to allow for
fast-restart-like behavior for DAFS. Call the flag -unsafe-nosalvage, and
document it, warning against its use.

Change-Id: I342c58745b7e2e1d1a2066b4fb08941b02c660f9
Reviewed-on: http://gerrit.openafs.org/2277
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-07-13 21:46:10 -07:00
Jeffrey Altman
2b85b8c31d Windows: Permit docbook validation using xmllint
Add a "check" rule to each of the docbook directories
that uses xmllint.exe (from Cygwin) to validate the
docbook source against the DTD.  Validation failures
will halt the build.

Change-Id: Ifcfcab11d5077381bfe7fa5e3767070a8d55cb21
Reviewed-on: http://gerrit.openafs.org/2391
Reviewed-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Tested-by: Jeffrey Altman <jaltman@openafs.org>
2010-07-13 06:05:30 -07:00
Jeffrey Altman
d4440319c3 Commit DTD validation errors in the Windows Release Notes
Correct errors detected using xmllint

Change-Id: I75c936084f116addbb7918856fe958b596e91b03
Reviewed-on: http://gerrit.openafs.org/2393
Reviewed-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Tested-by: Jeffrey Altman <jaltman@openafs.org>
2010-07-13 06:03:29 -07:00
Jeffrey Altman
6c78ce7962 Correct DTD validation errors in the UserGuide
Correct errors detected using xmllint

Change-Id: Idd9e91ef463679cb58bdb622fd600e4020224e81
Reviewed-on: http://gerrit.openafs.org/2394
Reviewed-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Jason Edgecombe <jason@rampaginggeek.com>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Tested-by: Jeffrey Altman <jaltman@openafs.org>
2010-07-13 06:03:11 -07:00
Jeffrey Altman
fb285880da Correct DTD validation errors in the AdminGuide
Correct DTD validation errors detected using xmllint.

Change-Id: Ia255ac319a81966e63b702dd2b672ff3d6d8958a
Reviewed-on: http://gerrit.openafs.org/2392
Reviewed-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-07-12 21:09:55 -07:00
Andrew Deason
5cc6293c2c Provide man pages for more fssync-debug commands
Provide man pages for the fssync-debug commands vgcadd, vgcdel,
vgcquery, vgcscan, vgcscanall, vnode, and volop.

Change-Id: If456a4cdfedbf5f2776c276bc20178319638c26a
Reviewed-on: http://gerrit.openafs.org/2239
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-07-12 11:53:41 -07:00
Michael Meffie
3ad8760f24 wiki url changed
Update the various places we reference the project wiki.

Change-Id: I56bcf038553eec02695667d737e0cd51e653b881
Reviewed-on: http://gerrit.openafs.org/2374
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-07-09 05:53:43 -07:00
Jeffrey Altman
4ca1b01025 Windows: update release notes for 1.5.75
Add:

 * better description of Win7 netbios name lookup bug

 * "fs newcell" changes

 * IdleDeadTimeout registry value

 * NatPingInterval registry value

 * ReadOnlyVolumeVersioning registry value

Change-Id: Ibf5ff8145be94ab8a7a48a1a9bd87c7d60e8549b
Reviewed-on: http://gerrit.openafs.org/2333
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Tested-by: Jeffrey Altman <jaltman@openafs.org>
2010-07-05 21:42:14 -07:00
Jeffrey Altman
e6a8d4ab2c Windows: ChangeLog for 1.5.75
Change-Id: Iff322bf65d9d8b5af58d6f4b53630256504999cb
Reviewed-on: http://gerrit.openafs.org/2332
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Tested-by: Jeffrey Altman <jaltman@openafs.org>
2010-07-05 21:41:47 -07:00
Derrick Brashear
bdf6192509 bosserver force corefiles
override system resource limits so we get corefiles

Change-Id: I50f228d709090c8275bed2fc2958653c43a0a026
Change-Id: I5b5e8c6a5e02ed0b28610949eb81f6345357969e
Reviewed-on: http://gerrit.openafs.org/1959
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2010-07-02 09:35:36 -07:00
Andrew Deason
368c44b537 Document fs -human
Document the new -human switch for 'fs diskfree' and 'fs listquota'.

Change-Id: Ic4b4f9d7492c887085ab6da4c802cfc75fd4d08e
Reviewed-on: http://gerrit.openafs.org/2314
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-07-01 10:05:51 -07:00
Andrew Deason
b126561c8d fs diskfree displays 'total' not 'kbytes'
Correct the fs manpage to show that 'fs diskfree' shows a header
called 'total' to represent the total disk space, not 'kbytes'.

Change-Id: Id827ec81dcfd79ab28eed3bc392524a378f0069d
Reviewed-on: http://gerrit.openafs.org/2313
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-07-01 10:04:07 -07:00
Andrew Deason
ee3d62beca vos: Interpret VLOP_* lock flags
When a volume is locked in the VLDB, we are given flags for the reason
why the lock was set. Make vos interpret and output this reason.

This adds output to any vos command that previously printed that a
volume was LOCKED. It now outputs, for example,

    Volume is currently LOCKED
    Volume is locked for a delete/misc operation

Change-Id: Ie3a6f804a3e3a551840975c3689b24d3916891df
Reviewed-on: http://gerrit.openafs.org/2235
Tested-by: Andrew Deason <adeason@sinenomine.net>
Reviewed-by: Jason Edgecombe <jason@rampaginggeek.com>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-06-23 15:01:09 -07:00
Andrew Deason
8db0c38235 Mention that -fakestat fakes local cellular mounts
The afsd man page says that -fakestat only fakes stat information for
cross-cell mount points. Technically it fakes stat information for all
cellular mount points, local or foreign. Most people shouldn't care,
but note the difference, since some places do have local cellular
mount points.

Change-Id: I9bc61a0284b7d04439578a4fc5a6adf791217463
Reviewed-on: http://gerrit.openafs.org/1979
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Russ Allbery <rra@stanford.edu>
Tested-by: Russ Allbery <rra@stanford.edu>
2010-06-23 14:42:12 -07:00
Davor Ocelic
8c633162b9 Provide manpage for fssync-debug and most subcmds
This is another patch in the series to provide manpages for
dafs-related commands.

Most (if not all) documentation is coming from source
documentation and DAFS articles/presentations.

The primary motivation behind this is to comply with Debian
guidelines requiring all binaries to have respective manpages.

This patch has been sitting here for months, so it's good time
to finally submit it.

Note that fssync-debug also supports some vcg* commands, for
which I was not able to find any documentation I could use.
So, they are still left to be documented.

Change-Id: I9d067766e2a90b26646edc87f15a4f533c5c8d44
Reviewed-on: http://gerrit.openafs.org/2220
Reviewed-by: Russ Allbery <rra@stanford.edu>
Tested-by: Russ Allbery <rra@stanford.edu>
2010-06-23 13:34:19 -07:00
Derrick Brashear
20bf8feacd no fs sa /afs in dynroot mode
change the quick start guide so people stop asking why they can't
set the ACL on /afs.

Change-Id: Iffc6c95564e99c01cef1b2b54d6b35e9bd01f38c
Reviewed-on: http://gerrit.openafs.org/1872
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-06-23 11:35:37 -07:00
Derrick Brashear
d8237165f7 afsd -dynroot-sparse mode for hushed cells
if an admin specifies -dynroot-sparse (instead of dynroot) come up
with just local cell and cell aliases showing. cell list
is configured as normal. fs newcell works as normal.

document it.

Change-Id: Ie644ed0f9923a85da5451eafaa114ddf36daa671
Reviewed-on: http://gerrit.openafs.org/2217
Reviewed-by: Andrew Deason <adeason@sinenomine.net>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-06-22 08:48:31 -07:00
Davor Ocelic
5f66bed5eb Update manpage links, fix doc typo in fssync-debug
Change-Id: I93a4fc4c998e489c6bdc736f0f4172c752d9f030
Reviewed-on: http://gerrit.openafs.org/2219
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-06-21 06:34:18 -07:00
Russ Allbery
9784847fed Rework the Kerberos Autoconf probes
Previously, building with Kerberos support required either passing a
flag to configure giving the location of a krb5-config script, or
manually setting variables specifying the Kerberos libraries and
header path.  Replace that code with code that checks for Kerberos
libraries automatically and builds the Kerberos code if any were
found, with support for doing direct library probing if there is no
krb5-config script.

Add several platform-specific overrides directly into the configure
support, so we should be able to build out of the box on Mac OS X 10.3,
HP-UX, and AIX Kerberos with the new probes.

The Kerberos Autoconf macros are now the versions that come with
rra-c-util and are tested with multiple other packages, so both
OpenAFS and those packages will be able to benefit from further
portability improvements.

Update README for the new building instructions, documenting how to
configure the Kerberos probes if they can't automatically figure out
the location and flags for Kerberos on your system.

Change-Id: Ia35bb0dbc6b94c6b4dfe8165388447dbfcb31a29
Reviewed-on: http://gerrit.openafs.org/2026
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-06-15 16:30:04 -07:00
Russ Allbery
084a7f1beb Document vos listaddrs -host and -uuid
Document the -host and -uuid flags to vos listaddrs.  They were mentioned
in the SYNOPSIS, but not in the OPTIONS section of the manual page.

Change-Id: I96e6b67b7239d9455060fd0c76b8d44f41a010a2
Reviewed-on: http://gerrit.openafs.org/2083
Reviewed-by: Russ Allbery <rra@stanford.edu>
Tested-by: Russ Allbery <rra@stanford.edu>
2010-06-12 18:03:42 -07:00
Russ Allbery
7c167febd5 Comprehensive edit of Admin Guide chapter two (first 20%)
Update and revise chapter two (Issues in Cell Configuration and
Administration) of the Administration Guide for current AFS and current
computing concepts.

Remove references to an AFS-provided login utility and discuss local login
configuration for Kerberos more generically.  Further clarify the role of
ssh in ensuring the user has access to files in AFS during remote login.
Improve the inode and namei discussion slightly.  Update the setuid
discussion for the new default of disabling setuid for cells and for the
known security flaws in enabling setuid.  Modernize terminology for DNS
around cell naming and remove the descriptions of TLDs.  We can now assume
our target audience knows this stuff.

Move index terms into the appropriate section for what's being indexed in
a few more cases.

Lots of other, more minor wording changes and updates.

Change-Id: Id8b1ace5afca6b8b7b2082a9a0779a4b91c89dcd
Reviewed-on: http://gerrit.openafs.org/2065
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Tested-by: Jeffrey Altman <jaltman@openafs.org>
2010-06-04 01:33:50 -07:00
Russ Allbery
a069b18dfb Document in SalvageLog(5) the per-partition salvager logs
Document that salvager creates separate logs per partition when doing
a full server salvage and then appends them all to SalvageLog when it
completes.

Change-Id: I2ffa8c79ef83b590f90bb014fc318559deae7113
Reviewed-on: http://gerrit.openafs.org/2035
Reviewed-by: Russ Allbery <rra@stanford.edu>
Tested-by: Russ Allbery <rra@stanford.edu>
2010-06-03 19:58:27 -07:00
Russ Allbery
af1dbcf0c9 Add warnings for Authentication Server commands
For each command only useful with the Authentication Server, add
warnings that the Authentication Server is obsolete and will be
removed in a future version of OpenAFS.  Encourage people who care
to update uss to work with a modern Kerberos KDC, recommend kinit
and aklog or klog.krb5 over klog, and warn that klog will be of
limited use without an Authentication Server.

Change-Id: Idc78ba548134b83ac1eea0fb81a5bc38a431bb38
Reviewed-on: http://gerrit.openafs.org/2052
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-05-31 20:40:58 -07:00
Russ Allbery
20c2acfb2b Reformat chapter two of the OpenAFS Administration Guide
Purely reformatting to make the document more maintainable.  There are
no content changes.

Change-Id: I349c8e86de925cbed6e09be529a22e0a08b227f6
Reviewed-on: http://gerrit.openafs.org/2059
Reviewed-by: Russ Allbery <rra@stanford.edu>
Tested-by: Russ Allbery <rra@stanford.edu>
2010-05-29 22:26:39 -07:00
Russ Allbery
ac971a6c85 Comprehensive edit of chapter one of the Administration Guide
Update and revise chapter one (An Overview of OpenAFS Administration)
of the Administration Guide for current AFS and current computing
concepts.

Replace the Kerberos Server terminology with Kerberos KDC and add
additional details about the relationship between AFS and a Kerberos
KDC.  Remove some remaining Authentication Server references.  Add
some details about the Protection Server management of the mapping
from Kerberos principals to AFS IDs.

Remove some now-obsolete distinctions and concepts between mainframes
and workstations and recommendations for server systems.

Reorganize the order in which the servers are discussed to follow a
somewhat more natural order.

Be clear that the Backup Server is optional and that there are other
methods available to back up AFS.  Mention backing up to disk as well
as tape in a few places.

Change-Id: I57ce083a84ca2a44f7a4383d80b05508e6448284
Reviewed-on: http://gerrit.openafs.org/2045
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-05-27 19:55:55 -07:00
Russ Allbery
760b43baa8 Reformat chapter one of the OpenAFS Administration Guide
Purely reformatting to make the document more maintainable.  There are
no content changes.

Change-Id: Ic3fb32ef68c14418b3ac6bab92fda759db89b394
Reviewed-on: http://gerrit.openafs.org/2044
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-05-27 19:55:23 -07:00
Russ Allbery
a65d755e5e Clean up the introduction to the Administration Guide
Provide a more useful abstract and remove the (outdated) specific list
of supported platforms and the M.m version number placeholders.  Update
the list of associated documents to match their current titles, and
provide a better description of the Reference Manual.

Reformat the parent document and preface for easier maintenance in the
future.

Change-Id: I42ce78274ed7c4ca7a2f0b9c5ec2e6f7a786adb8
Reviewed-on: http://gerrit.openafs.org/2043
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Russ Allbery <rra@stanford.edu>
Tested-by: Russ Allbery <rra@stanford.edu>
2010-05-27 14:44:33 -07:00
Russ Allbery
5f70221b2c Remove references to IBM AFS
Change references to the documentation sets that we still ship to
reference the OpenAFS manuals instead of the IBM AFS manuals.  Remove
references to the IBM AFS/DFS Migration documentation, since that
doesn't appear to be available anywhere any more, replacing them where
relevant to more generic references to the DFS documentation.  Add
links to docs.openafs.org for mentions of the manuals in SEE ALSO, and
standardize on one link format.  Replace a few references to the IBM
AFS Release Notes with the actual information in those notes, or drop
the reference if it doesn't seem particularly useful.

Change-Id: Ie9666842f1315891c6a9c37c0424200f4b78bff7
Reviewed-on: http://gerrit.openafs.org/2031
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-05-26 12:05:45 -07:00
Russ Allbery
9f9ffb7822 Remove references to AFS Product Support in -oktozap
salvager and salvageserver's documentation of -oktozap says to not use
without consultation with AFS Development or Product Support, left over
from the IBM product.  Remove those references and add a caution more
in line with open source.

Change-Id: I136dc145caf3e8e3a992c239e1a46d86f96580ed
Reviewed-on: http://gerrit.openafs.org/2030
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2010-05-26 09:39:47 -07:00
Russ Allbery
1f22cab96a Remove -rebuildDB flag to ptserver
The -rebuildDB flag was documented to rebuild the Protection Database at
startup, but it was accepted and ignored in the ptserver source, doing
nothing.  Remove the documentation and the option recognition in ptserver.

Change-Id: I36f30f38464b602cb4739a958663a6feb5fe27bf
Reviewed-on: http://gerrit.openafs.org/2029
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-05-26 09:39:27 -07:00
Russ Allbery
46192481ec Remove documentation of kaserver -fastKeys
-fastKeys wasn't accepted by the kaserver binary, but was still
mentioned in the usage message and the kaserver man page.  Remove
the remnants of the flag.

Change-Id: Ifb3ae49ea0cab80c325a77b0eb1062944697b53d
Reviewed-on: http://gerrit.openafs.org/2028
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-05-26 09:38:35 -07:00
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
0875e29832 Synchronize LICENSE files
We have two LICENSE files, which had been somewhat independently
modified.  Resynchronize them, remove trailing whitespace, and convert
from ISO 8859-1 to UTF-8.

Change-Id: Ia3dba0e328e7f026362e2e8efda206c34ce4e768
Reviewed-on: http://gerrit.openafs.org/2025
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-05-25 21:27: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
Russ Allbery
3015ef6c59 Update bos addkey/listkeys and KeyFile man pages for asetkey
Clearly prefer asetkey to bos addkey in the KeyFile, bos addkey, and
bos listkeys man pages.  Reference asetkey list and asetkey delete as
alternatives to bos listkeys and bos removekey.  Distinguish between
Authentication Server cells and Kerberos v5 cells and mention the
preferred afs/<cell> principal format.  Add some cautions around
matching enctypes and salts when synchronizing keys with a v5 KDC.

Update man-pages/README for completion of this task, clean up some
other wording, and remove some other now-irrelevant information.

Change-Id: I29b83a61cbdb08de508bdb313524a307e385044b
Reviewed-on: http://gerrit.openafs.org/1938
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Andrew Deason <adeason@sinenomine.net>
Tested-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Russ Allbery <rra@stanford.edu>
2010-05-22 17:18:16 -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
6bde63c465 Add RFC 5864 to the protocol documentation directory
Add a copy of RFC 5864 (DNS SRV Resource Records for AFS) to the
protocol documentation directory for reference.  As permitted by
the IETF Trust License Policy section 3(e), I release this document
under the MIT/X Consortium license included in this copy of the
document.

LICENSE MIT

Change-Id: I8e22aac07b4cedbe18b8375213a7866cf98a1386
Reviewed-on: http://gerrit.openafs.org/1799
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2010-04-21 05:59:31 -07:00
Russ Allbery
e8d6d9dfd7 Install afsd.fuse and man page if built
If --enable-fuse-client is passed to configure and afsd.fuse is built,
install it into the same directory as afsd and install afsd.fuse.8 as a
symlink to the afsd.8 man page.  Add documentation of afsd.fuse to the
afsd man page.

Change-Id: I7d0cd3992a8466e626af2191c713e5623cc40d84
Reviewed-on: http://gerrit.openafs.org/1792
Tested-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-04-21 05:59:05 -07:00
Andrew Deason
7321493788 Add documentation for fs callback xstats
Change I572ff682de4cc7ef27bb46dd028d3d797b873841 added the fileserver
callback xstats collection to afsmonitor. Provide some documentation
for these fields, along with the other fields displayed by afsmonitor.

Change-Id: I21618047519fbb28f6707ff9ba95a17fe27e0f3c
Reviewed-on: http://gerrit.openafs.org/1783
Tested-by: Andrew Deason <adeason@sinenomine.net>
Reviewed-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2010-04-21 05:55:40 -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
Jeffrey Altman
a9018b3132 Windows: 1.5.74 change log
Important changes affecting the Windows distribution for 1.5.74

Change-Id: I980a66a2ab4a90c580249641fc22e3c7a91097dc
Reviewed-on: http://gerrit.openafs.org/1770
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Tested-by: Jeffrey Altman <jaltman@openafs.org>
2010-04-17 08:45:14 -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
Russ Allbery
75cf37f944 Explain in CellServDB man page that server lines can be omitted
It's possible to use AFSDB records only to locate the VLDB servers but
still list the cell in the client CellServDB so that the client is
aware of it and populates it into dynroot.  Describe doing this in the
man page.

Change-Id: I714cd515dc4b72a6e358bbd8f9332d4ddce5a5fc
Reviewed-on: http://gerrit.openafs.org/1710
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-04-07 16:19:27 -07:00
Andrew Deason
be44999904 Fix typo in bos_create manpage
Change-Id: I1ea456e47eccc0a74f042898ef8a3bcde3aacf15
Reviewed-on: http://gerrit.openafs.org/1709
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-04-07 09:02:12 -07:00
Russ Allbery
7d395f1754 Improve demand-attach fileserver bos documentation
Add a caution to the fileserver man page explaining that traditional
and demand-attach require different configurations, and also mention
that there are two different server implementations.  Add an example
of a bos create command for creating a demand-attach File Server to
the fileserver man page.

Add a caution to the bos create man page that a traditional fs node
won't work with demand-attach and vice versa.  Document the necessary
arguments for the dafs type.  Clarify in EXAMPLES which bos create
commands are traditional and which are demand-attach.  Add an example
of changing from a traditional to a demand-attach configuration.

Change kaserver to ptserver in the example of a simple process.

Change-Id: I4077246b69edf6e1ddc7c0761ac8e1006d471c24
Reviewed-on: http://gerrit.openafs.org/1707
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-04-06 20:07:53 -07:00
Jeffrey Altman
eb25c5b1c3 Windows: Support new Cygwin docbook stylesheet location
Make the computation of the docbook stylesheet location
based upon testing for directory existence now that versions
of cygwin 1.7.2 and place the stylesheets in a new location.

Change-Id: I844ae35a34eab73ee033bba875e68f71dc54f26b
Reviewed-on: http://gerrit.openafs.org/1702
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Tested-by: Jeffrey Altman <jaltman@openafs.org>
2010-04-06 12:22:15 -07:00
Jeffrey Altman
0bc5b666b1 Windows: tag is listitem not llstitem
Latest version of docbook picked this error up.

Change-Id: I2e6248d27e56c0074b0f80124733b79d7d1b51f0
Reviewed-on: http://gerrit.openafs.org/1699
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Tested-by: Jeffrey Altman <jaltman@openafs.org>
2010-04-06 12:21:22 -07:00
Davor Ocelic
2f4a1897bf Minor state_analyzer manpage corrections
Done according to adeason's comments on http://gerrit.openafs.org/#change,1655

Change-Id: Ia5b28473fa37ad2a877a5a56b1b7f1c4893e8db1
Reviewed-on: http://gerrit.openafs.org/1666
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-03-29 08:04:42 -07:00
Davor Ocelic
326ff2aa68 Initial; add state_analyzer manpage
Change-Id: I5dd43e6ea5764421a6e44f372f4e9c9576de627e
Reviewed-on: http://gerrit.openafs.org/1655
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-03-28 20:55:05 -07:00
Derrick Brashear
6fc9718446 make 1.5.73 relnotes
release notes for 1.5.73

Change-Id: I4fd8d0b40f97311f42ee77f9245bd9e9cb87188f
Reviewed-on: http://gerrit.openafs.org/1642
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-03-23 21:23:16 -07:00
Booker Bense
fc145e7162 Updating UserGuide with Kerberos v5 authentication
This patchset contains updates to the OpenAFS UserGuide that
explains how to authentication OpenAFS using kinit/aklog
and uses language describing Kerberos outside the context
of the kaserver.  References to applications such as telnet
have been replaced with more modern equivalents such as ssh.

Change-Id: Ifae779b04a26beb9be9cf58b450958acdc477c06
Reviewed-on: http://gerrit.openafs.org/1521
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2010-03-23 21:17:00 -07:00
Derrick Brashear
7ca634f7f8 add missed release notes
these are the release notes available via the web but not here.

Change-Id: Ieb4af99a4d6a1dfdaabccdac79d03f7d328de675
Reviewed-on: http://gerrit.openafs.org/1641
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-03-23 20:46:40 -07:00
Jeffrey Altman
766c7e4cdf Windows: changelog for 1.5.73
Change-Id: I83ab533c7ec52b82e76a857f3ac4a12e1d8b1939
Reviewed-on: http://gerrit.openafs.org/1636
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-03-23 18:05:40 -07:00
Russ Allbery
189a99e894 vldb_check man page should say -vheader, not -pheader
The option was given correctly in SYNOPSIS but not in the OPTIONS section.
Thanks, Rod Widdowson.

FIXES 126771

Change-Id: Ibd9694c066b6750ad04273c22e66c84fb7b4a1c6
Reviewed-on: http://gerrit.openafs.org/1589
Reviewed-by: Rod Widdowson <rdw@steadingsoftware.com>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-03-23 12:27:59 -07:00
Derrick Brashear
da68c39de1 kill apsl afssettings and fstab
replace both

afssettings with something patterned from webdav's (BSD-licensed)
mount program with general plist reading code. the lists of
valid oid objects of course have to be the same. eject old
darwins. add the new one.

fstab with something from freebsd umount

Change-Id: I28f6765475314b9b78102c762daec19cda4988c3
Reviewed-on: http://gerrit.openafs.org/1583
Reviewed-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-03-17 19:57:55 -07:00
Andrew Deason
3cffaee790 DAFS: Replace partition locks with volume locks
In DAFS, replace uses of the VLockPartition_r partition-level locks with
the approprivate VLockVolume*NB volume-level locks (and sometimes
FSYNC_VerifyCheckout). This allows for greater parallelization of
volserver attachment / volume creation, for volume operations to occur
during salvages, and for multiple salvages on a single partition to
occur simultaneously.

More architectural details of volume-level locks can be found in the
changes to doc/arch/dafs-overview.txt.

Change-Id: I4e8ef4c864002d7e7c976691824c53dfa9cfaf91
Reviewed-on: http://gerrit.openafs.org/1406
Tested-by: Andrew Deason <adeason@sinenomine.net>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-03-17 10:29:31 -07:00
Andrew Deason
aa8c114454 Add DAFS documentation overview for developers
Add some developer documentation for DAFS. This isn't comprehensive or
extremely detailed, but is intended to provide a larger-picture overview
of some of the pieces of DAFS. More detailed docs are intended to exist
in source comments (doxygen and such), and should already be there for
the most part.

Change-Id: I167b52c3bfb9e6b4b7111b3548ca8b1dafe305ea
Reviewed-on: http://gerrit.openafs.org/1376
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-03-09 11:08:15 -08:00
Jason Edgecombe
5fae0f0b9a Add a section on how to tune the AFS cache using xstat_cm_test
The cache tuning section covers how to use xstat_cm_test to measure
the cache miss percentage.

LICENSE BSD

Change-Id: I895dbbecd7e16d44e18fa65e5e1aa1da5c567a06
Reviewed-on: http://gerrit.openafs.org/1308
Tested-by: Jason Edgecombe <jason@rampaginggeek.com>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Russ Allbery <rra@stanford.edu>
Tested-by: Russ Allbery <rra@stanford.edu>
2010-03-02 16:23:41 -08:00
Andrew Deason
60e8dcb4e6 DAFS: Maintain viced volume group hierarchy cache
When salvaging a volume (with DAFS or not), it is required to read the
volume headers of all volumes on the partition, so we know what volumes
are in the same volume group as the salvaged volume. Currently with
DAFS, this requirement can make demand-salvages very slow, since each
demand-salvage must read each volume header on the partition.

So, instead of having each demand-salvage read the volume headers
itself, have a demand-salvage request the required volume group
hierarchy information from the fileserver. The fileserver will scan the
partition's volume headers, and will keep the hierarchy cached in
memory. Any modifications to this hierarchy from volume
creation/deletion will update this volume group cache (VGC) via FSSYNC
commands.

This results in a dramatic salvaging speedup when many demand-salvages
are requested, and eliminates the cases where DAFS salvaging can be
significantly slower than non-DAFS salvaging.

FIXES 124488

Change-Id: Ie9ae655593ad8a90ca6ad8f63e6b6e799f283988
Reviewed-on: http://gerrit.openafs.org/880
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-02-17 09:33:18 -08:00
Jason Edgecombe
8ea6c727aa Some minor rewording and grammatical tweaks of the CellAlias man page
Added some text that the CellAlias file is only used on Unix.

LICENSE BSD

Change-Id: I913d6a0774240ffc16cf92cfa92c4b2d06f41fd6
Reviewed-on: http://gerrit.openafs.org/1307
Tested-by: Jason Edgecombe <jason@rampaginggeek.com>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-02-15 04:53:37 -08:00
Andrew Deason
769be238b0 Document FSSYNC commands
Provide some explanation for the various FSSYNC commands, and what they
are there for.

Change-Id: I572300b66cc8b6a1b0f2aa185edd198c237f7225
Reviewed-on: http://gerrit.openafs.org/1236
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-02-11 23:00:07 -08:00
Jeffrey Altman
23848b4b74 Windows: 1.5.72
Change-Id: Ifef2538d2020e9ecb17bc1ac7176c99f2651a96a
Reviewed-on: http://gerrit.openafs.org/1292
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2010-02-10 21:32:17 -08: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
Jeffrey Altman
e1fd1f60d3 Windows: ChangeLog and Version Number for 1.5.71
Change-Id: I0969e2b3fcff98489aef1b0e660ef12149a4b96c
Reviewed-on: http://gerrit.openafs.org/1184
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-01-31 21:46:52 -08:00
Jeffrey Altman
aacc766252 Windows: 1.5.70
ChangeLog updates

Version number updates

Change-Id: I16fd2d2ef507cc862417eef8d221ea5ba58567a1
Reviewed-on: http://gerrit.openafs.org/1146
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Tested-by: Jeffrey Altman <jaltman@openafs.org>
2010-01-24 07:15:03 -08:00
Jeffrey Altman
e33a7346a6 Windows: ChangeLog for 1.5.69
Change-Id: I078f719c6e769cfcb7997bb8b67403de480255f9
Reviewed-on: http://gerrit.openafs.org/1114
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-01-18 17:34:10 -08:00
Asanka Herath
62e4bf7ddd Fix typo in AdminGuide
</pare> -> </para>

Change-Id: If0f8183f59f038b1b5e033d5ebd2607b5091f6da
Reviewed-on: http://gerrit.openafs.org/1103
Reviewed-by: Russ Allbery <rra@stanford.edu>
Tested-by: Russ Allbery <rra@stanford.edu>
2010-01-14 16:20:58 -08:00
Simon Wilkinson
9b23804a82 Remove weekly bosserver restarts
Change the default so new installations of the bosserver have
no weekly restarts. Update the manpage and XML documentation to
reflect this change.

FIXES 126138

Change-Id: Ic22b750a602f6d2a22be881f5e1b04cd4fa132ae
Reviewed-on: http://gerrit.openafs.org/1097
Reviewed-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-01-14 07:01:16 -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
f085951d39 Turn on bos restricted code
Remove the #ifdef's around the bos restricted mode code. This makes
restricted mode available as part of the standard build, but a server
will not go into restricted mode unless the relevant command line
options are specified, or bos setrestricted is run.

Document bos_setrestricted and bos_getrestricted, and the new
'-restricted' command line option. Add a note to the man pages of
all of the commands whose behaviour is affected by restricted mode.

Add 'setr' and 'getr' aliases for setrestart and getrestart so that
these documented shortcuts continue to work (otherwise they'd be
ambiguous against setrestricted and getrestricted). Note that
setre, setres, and setrest will not work once this patch is applied.

Change-Id: Ie69d21493ea5f78757f0a3d478de43fdaabd3c31
Reviewed-on: http://gerrit.openafs.org/1028
Reviewed-by: Michael Meffie <mmeffie@sinenomine.net>
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>
2009-12-31 04:54:52 -08:00
Simon Wilkinson
99d0070673 Documentation: Fix asetkey syntax
To set a key, use "asetkey add", not just "asetkey"

FIXES 125430

Change-Id: Ifa381ec95f9253bcc5c7a1d374fbf88408f82f67
Reviewed-on: http://gerrit.openafs.org/1045
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2009-12-29 18:19:36 -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
Simon Wilkinson
33a87fce6b pt_util runs on database servers
Fix the pt_util manpage to reflect the fact that it is run on database
servers, not fileservers.

Change-Id: If2a8e5b65ef925c50eb9bfebea4e0d30c20f0970
Reviewed-on: http://gerrit.openafs.org/901
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-12-08 07:25:27 -08:00
Jeffrey Altman
96eaa67edb Windows: change notes for 1.5.67 release
Change-Id: I0eedd81fbfee98c591cfd57364bc23392ccca2da
Reviewed-on: http://gerrit.openafs.org/884
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-12-03 12:55:59 -08:00
Mickey Lane
ca9a12c422 Fix 2 errors in Windows release Notes
Description of registry key HKLM\ SOFTWARE\ OpenAFS\
Client\ Server Preferences\ File (and \ VLDB) states
"256" - should be 15 - and "ServerPreferences" should
have a space between the words.

Change-Id: Ia2147f920ecc023d26250efaf9815f1b09d1550a
Reviewed-on: http://gerrit.openafs.org/840
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-11-19 08:58:12 -08:00
matt@linuxbox.com
0a8e7b1548 viced ihandle boost
Make ihandle file descriptor cache parameters tunable, and accommodate
platforms where max open files is large.  Expand the fd cache hash table
to 2048 entries.  Raise fd cache size automatically to match configured
number of lwps.

NOTE: This code has been tested on Centos 5.3 x86_64, on VMWare, 2 physical,
2 logical CPUs (in tandem with viced_more_threads).

LICENSE BSD

Change-Id: If68eda6e1c955e026b250ca52bddf0b8383959c9
Change-Id: I5fbbec95523ea9cd9ff42dcf43f17db94c7bb161
Reviewed-on: http://gerrit.openafs.org/584
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2009-11-18 13:14:37 -08:00
Russ Allbery
24de8dae6d Update afsd cache and firewall details
Cache parameters are discussed in two locations in the afsd man page,
and the first copy had not been updated for the new auto-tuning of
the chunk size and the stat parameter.  Fix both.

Note that the firewall requirements for klog only apply if you're using
kaserver and klog.  Kerberos v5 has its own requirements, but this is not
the place to talk about them.

Change-Id: I9cdaaa71351a64cecc1b6904efba87d4871d42fb
Reviewed-on: http://gerrit.openafs.org/798
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2009-11-10 08:53:38 -08:00
Simon Wilkinson
7833e472b9 Make afsd.pod reflect reality
9d396c4916 (from 2005) introduced
autotuning for afsd, and changed some of the defaults which aren't
autotuned. Update the afsd man page to reflect the autotuning, and
the new defaults.

Change-Id: Iea2035743cb45cca1c249bc2e838405039ad7d3a
Reviewed-on: http://gerrit.openafs.org/744
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-10-28 12:02:38 -07:00
Jeffrey Altman
ecfeb5365f Windows: Notes for 1.5.66
ChangeLog description for 1.5.66 on Windows.

Reviewed-on: http://gerrit.openafs.org/720
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-10-23 00:17:01 -07:00
Jeffrey Altman
d0080431fa Windows: Updates to Release Notes
Add support for Windows 7 and Server 2008 R2.

Improve text in a variety of areas.

LICENSE MIT

Reviewed-on: http://gerrit.openafs.org/719
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-10-23 00:06:38 -07: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
94eae9ed26 Update README with solved/pending docs tasks
Reviewed-on: http://gerrit.openafs.org/618
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-10-08 15:41:33 -07:00
Davor Ocelic
04fa499ac9 Update backup suite manpages
-- Add missing POD links (L<>)

 -- Verify all subcommands and options

 -- Format > 80 columns synopsis lines

Reviewed-on: http://gerrit.openafs.org/617
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-10-08 15:40:35 -07:00
Davor Ocelic
a6e15c992e Update fstrace suite manpages
-- Add missing POD links (L<>)

 -- Verify all subcommands and options

 -- Format > 80 columns synopsis lines

Reviewed-on: http://gerrit.openafs.org/616
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-10-08 15:28:56 -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
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
Jeffrey Altman
75dbaa82cd Windows: change log for 1.5.65
LICENSE: MIT
Reviewed-on: http://gerrit.openafs.org/559
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-09-30 14:35:03 -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
Derrick Brashear
f3c3e4da18 DAFS protocol state diagrams
update DAFS protocol state diagrams

FIXES 124990

Reviewed-on: http://gerrit.openafs.org/485
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-09-22 01:53:02 -07:00
Jeffrey Altman
91d9ca106d Windows: 1.5.64 updates for Windows Notes
LICENSE MIT

Reviewed-on: http://gerrit.openafs.org/475
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-09-21 09:14:21 -07:00
Jeffrey Altman
bb4a5038d9 Add indexing to Windows Release Notes
An initial pass at adding indexing to the Windows release notes.
The next pass should refine the index terms and add appropriate
secondary index values.

LICENSE MIT

Reviewed-on: http://gerrit.openafs.org/454
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-09-13 07:34:23 -07:00
Jeffrey Altman
d190d2400e Windows Release Notes XML
Reformat the Registry and Environment Values in Appendix A
so that they are easier to identify in the table of contents.

LICENSE MIT

Reviewed-on: http://gerrit.openafs.org/453
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Tested-by: Jeffrey Altman <jaltman@openafs.org>
2009-09-13 07:32:01 -07:00
Jeffrey Altman
60c44cc6dd Windows: changelog updates for 1.5.63
LICENSE MIT

Reviewed-on: http://gerrit.openafs.org/444
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-09-11 10:01:13 -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
Jason Edgecombe
fb79d6e1f0 Updated Chapter 2, Section 3.4 of the Admin Guide
Added a bullet point explaining the use of a Kerberos cross-realm trust and PTS
foreign groups to give foreign users access.

Replaced a reference to Authentication Database with Kerberos Database.

LICENSE BSD

Reviewed-on: http://gerrit.openafs.org/381
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2009-09-03 11:02:16 -07:00
Jason Edgecombe
d352ca1df4 Updated Chapter 2, Section 3.2 of the Admin Guide
Removed the reference to the Authentication Server and added a reference to the Kerberos Server and Kerberos 5 authentication for foreign clients.

Replaced AFS Product Support with the AFS registrar as the maintainer of the
public CellServDB file. A link was added to grand.central.org for getting the
latest copy of the file and submitting changes for the local site.

Reviewed-on: http://gerrit.openafs.org/379
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2009-09-02 16:02:28 -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
Jason Edgecombe
67bcc19c75 Updated Chapter 2, Section 3.3 of the Admin Guide
Added text about Freelance Mode and Dynamric Root Mode and the changes they
cause when dealing with mounts to foreign cells in /afs and \\AFS

Reviewed-on: http://gerrit.openafs.org/380
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2009-09-01 03:22:58 -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
Jeffrey Altman
af8dee05f0 Windows: Release Notes Updates for 1.5.62
Some formatting corrections

Section 3.26 updated to describe limitations caused by Apple
Bonjour on 32-bit Windows.

Section 3.40 updated to mentions Microsoft SMB Redirector
Extended Server Timeout support.

Section 3.41 updated to describe inability of pioctl operations
to succeed on service mapped drives.

Section 3.43 updated to include Windows 7 and Server 2008
in the known issues list.

New section 3.51 on Microsoft RPC Services

LICENSE MIT

Reviewed-on: http://gerrit.openafs.org/346
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-08-26 19:37:43 -07:00
Jeffrey Altman
d605bf109d Windows: Updates to Windows ChangeLog
1.5.6200

LICENSE MIT

Reviewed-on: http://gerrit.openafs.org/345
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-08-26 19:37:23 -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
Jeffrey Altman
a13d8146a3 Add generated files to doc/xml/AdminGuide .gitignore
Add htmlhelp.hhp, index.hhk, and toc.hhc

Reviewed-on: http://gerrit.openafs.org/259
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-08-02 05:41:53 -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
Jeffrey Altman
5d8c3f6758 Windows: Version and ChangeLog updates for 1.5.61
1.5.61 == 1.5.6100.0

LICENSE MIT

Reviewed-on: http://gerrit.openafs.org/255
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-07-31 14:48:34 -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
Jeffrey Altman
1c24db09fa Add/Update .gitignore files for Windows builds
Many Windows files were not included in the .gitignore files.
Many directories did not have .gitignore files at all.
Add and update where required.

LICENSE IPL10

Reviewed-on: http://gerrit.openafs.org/103
Verified-by: Simon Wilkinson <sxw@inf.ed.ac.uk>
Reviewed-by: Simon Wilkinson <sxw@inf.ed.ac.uk>
Verified-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-07-15 18:37:16 -06:00
Jason Edgecombe
8a2330a9a6 Updated chapter 2, sections 1-3 of the Admin Guide
Replaced some references to the Authentication Database with Kerberos.
Removed text about obsolete tools like rcp, inetd, and rlogin.
Corrected references to AFS Product support by replacing them with links
to the OpenAFS Support page. Added warnings about using the wrong fsck binary
with inode and namei-based fileserver binaries. Removed an obsolete paragraph
about ThisCell and how it interacts with the Authentication Database.

LICENSE BSD
FIXES 124931

Reviewed-on: http://gerrit.openafs.org/10
Verified-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Verified-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Russ Allbery <rra@stanford.edu>
2009-07-14 21:07:50 -06: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
Simon Wilkinson
ba9ad62845 Revise git ignore files
Revise our git ignores to match the current state of the tree, and include
entires in the top level for all of the 'dest' directories for all of the
architectures we claim to support.

Reviewed-on: http://gerrit.openafs.org/2
Reviewed-by: Derrick Brashear <shadow@gmail.com>
Verified-by: Simon Wilkinson <sxw@inf.ed.ac.uk>
2009-07-06 10:03:23 -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
dad31c8ca5 windows-notes-20090607
LICENSE MIT

synchronize with the 1.5 branch
2009-06-08 03:34:28 +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
ee2d4a858b death-to-docs-20090605
LICENSE IPL10

docs now built from doc/xml; kill the other copies of same
2009-06-05 16:50:10 +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
Jason Edgecombe
d7b3953a53 doc-admin-guide-updates-20090601
LICENSE BSD
FIXES 124889

Updates to chapter one of the Admin Guide.  Remove references to the
Authentication Server, add references to a Kerberos server, revise ntpd
parts to reflect the fact that OpenAFS doesn't ship ntpd, and removed
the distinction between the US and non-US versions of the Update Server.
2009-06-01 23:35:17 +00:00
Russ Allbery
e34fe0f9a8 doc-xml-build-cvsignore-20090601
LICENSE BSD

Ignore new generated files from the documentation build.
2009-06-01 23:31:47 +00:00
Russ Allbery
2520cc9aab doc-xml-version-depends-20090601
LICENSE BSD

Make PDF manual generation also depend on version.xml, matching HTML
generation.
2009-06-01 23:30:42 +00:00
Jeffrey Altman
5526ba218f doc-doxygen-20090531
LICENSE BSD

Doxygen converted versions of the IBM provided architecture and
protocol documentation.

Funded under an SBIR grant.
2009-05-31 17:52:46 +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
Derrick Brashear
e452c704c5 xml-doc-building-glue-20090527
LICENSE IPL10
FIXES 124804

add configure switches for building docs. generate version files needed.
2009-05-27 20:44: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
e754a0bebd doc-xml-windows-release-notes-20090526
LICENSE MIT

Add notes describing registry support for CellServDB info and
conversion of docs to HtmlHelp format.
2009-05-26 16:29:16 +00:00
Jeffrey Altman
582688f1be windows-xml-release-notes-version-20090525
LICENSE MIT

autogenerate version info.

fix chapter title.
2009-05-26 03:20:06 +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
Jeffrey Altman
e4b36071ef doc-xml-version-generation-20090521
LICENSE MIT

Replace version info in the DocBook files with a new ENTITY "version"
associated with a local "version.xml" file which contain a <revision>
tag for the current release.

The version.xml file should be autogenerated by the Makefile system.
2009-05-21 18:51:42 +00:00
Jeffrey Altman
85a10ffc93 doc-xml-windows-20090519
LICENSE IPL10

remove references to xml files no longer in the repository
2009-05-20 05:53:57 +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
7b56f2ebfc doc-xml-build-20090518
LICENSE MIT

Standardize the UNIX Makefiles for all of the DocBook guides.  Remove the
rest of the generated files and switch to xsltproc and dblatex for the
document generation in all cases.  Fix a few DocBook errors by removing
the contents of the <index> tag and removing the unknown <pubsnumber> tag
in the <revision> field.
2009-05-19 04:58:53 +00:00
Russ Allbery
74585aa500 doc-quick-start-unix-build-20090518
LICENSE MIT

Use dblatex to build PDF documentation instead of docbook2html and xsltproc
to build HTML instead of docbook2html.  Remove all the index generation
logic, since dblatex and xsltproc handle that automatically.  Remove the
contents of the <index> tag in the source, since neither program requires
there be anything in there.

Remove the style sheets and configuration that were used for docbook2*.
2009-05-19 04:27:36 +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
Jeffrey Altman
fb985eefce doc-xml-release-notes-windows-20090514
LICENSE MIT

Initial take at converting the OpenAFS for Windows Release Notes
to DocBook.

Website style HTML and HtmlHelp (.chm) output is generated.

Formatting of Registry Value descriptions could be improved.

There is no indexing at present.
2009-05-14 18:47:44 +00:00
Jeffrey Altman
9e8e080a5c doc-xml-20090513
LICENSE IPL10
FIXES 124760

Remove generated HTML from the respository

Update XML to support autogeneration of Index files via XSLT

Add graphics referenced by generated HTML output

Add top level index.html used by the docs.openafs.org web site.

Add NTMakefile for AdminGuide, QuickStartUnix, and UserGuide
that utilizes XSLT to generate Windows HTMLHelp (.CHM) and
website appropriate HTML output.

In AdminGuide and UserGuide, relabel the documentation as OpenAFS
instead of IBM AFS.  Create a new revision entry for the OpenAFS
docs.

Incorporate updates to QuickStartUnix Appendix A
2009-05-14 03:25:35 +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
Derrick Brashear
c8ac7d1c49 man-pages-allow-dots-consistent-20090505
LICENSE IPL10

make all server man pages list -allow-dotted-principals (rather than
-allow-dotted-principal)
2009-05-05 13:30:24 +00:00
Jason Edgecombe
758366c26a netinfo-fake-address-text-20090427
LICENSE IPL10
FIXES 124699

explain fake address support for NetInfo files
2009-04-27 19:37:25 +00:00
Derrick Brashear
e59b81c984 dynamic-vcache-allocation-20090319
LICENSE IPL10
FIXES 124334

add dynamic allocation of vcaches when possible (currently just for linux)
2009-03-20 02:30:49 +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
Steven Jenkins
43bcfaf9cc vldb-check-meaningful-return-codes-20090216
LICENSE IPL10
FIXES 124321

make vldb_check have meaningful return codes
2009-02-17 04:16:56 +00:00
Russ Allbery
d476340465 man-page-salvager-fixes-20090201
LICENSE BSD

Fix the -parallel example in the main description text: "5all" should be
"all5".  Reword the description a bit to hopefully make it clearer that
there are two separate values set here.  Note under the option description
of -parallel that multiple partitions on the same device are normally
processed serially.
2009-02-02 01:19:00 +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
80fc888a92 netrestrict-no-wildcard-20090106
LICENSE IPL10

don't misadvertise network wildcard support
2009-01-06 13:40:04 +00:00
Russ Allbery
a3c9b01f3a man-page-fileserver-fix-block-size-20081111
After code study, we've decided that additional blocks do add 32 octets,
not 16, despite messages to the contrary in the archives.
2008-11-12 02:30:58 +00:00
Jason Edgecombe
794967ed3e man-page-fileserver-updates-20081111
LICENSE BSD

Various file server man page updates: number of partitions, partition size
limits, directory file name block size, and a reference to the IBM manual
set.
2008-11-12 02:17:49 +00:00
Russ Allbery
196e995b25 man-page-fileserver-octet-20081111
LICENSE BSD

The sizing limit on directories is better expressed in octets than in
characters in the new possibly-Unicode world.
2008-11-12 02:00:27 +00:00
Jason Edgecombe
32c271187a doc-user-guide-acl-example-fix-20081106
FIXES 123331
LICENSE BSD

fs sa takes a directory as its first argument.
2008-11-07 00:26:17 +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
Derrick Brashear
12c8abc690 server-argument-consistency-and-jumbograms-off-20080824
LICENSE IPL10
FIXES 108703

go through and make servers able to take debug log level on command line;
add -jumbo; default to -nojumbo
2008-08-25 02:14:39 +00:00
Russ Allbery
8009b045aa man-page-fileserver-long-line-20080717
LICENSE BSD

Fix long line in the SYNOPSIS for the fileserver man page.
2008-07-18 07:14:12 +00:00
Russ Allbery
6a322e4eb7 man-page-html-index-underscores-20080713
LICENSE BSD

Remove underscores from the anchor in the index for all section 5 manual
pages.
2008-07-14 03:27:00 +00:00
Russ Allbery
2a92f43987 man-page-html-generation-hack-20080713
LICENSE BSD

Pod::Simple::Search ignores every POD file that doesn't "look right," which
means it skips files containing a period (like krb.conf.pod) unless you set
a search option.  Pod::Simple::HTMLBatch has no way to set search options.

Apply a truly horrible hack to get around this.
2008-07-14 02:45:14 +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
9b61f58fa7 man-page-html-index-20080630
LICENSE BSD

Use the correct subcommand name (fs getacl instead of fs_getacl) on the
HTML index page, even though we have to use the underscore in the NAME
section of the actual POD documentation.
2008-06-30 23:35:18 +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
cf816d535a man-page-readme-update-20080630
LICENSE BSD

Add additional missing commands to the to-do list.  Add a section on man
page section numbers and their rationale.  Document that embedding a
license in the man page isn't required if it's one of the licenses in our
LICENSE file.
2008-06-30 20:47:30 +00:00
Jeffrey Altman
5da4137cbe windows-remove-ibm-docs-20080628
LICENSE MIT

Remove (from the en_US distributions) the IBM Quick Guide and IBM
Release Notes.  Update references and installers.
2008-06-29 06:08:00 +00:00
Jeffrey Altman
618a180164 windows-generate-html-cmdref-makefile-argh-20080628
LICENSE MIT

It would be nice if we added the file to the correct directory.

Add Windows makefile to build the html cmdref files from the pod man-pages
2008-06-29 02:48:18 +00:00
Jeffrey Altman
da989e5d95 windows-generate-html-cmdref-makefile-correct-20080628
LICENSE MIT

commit the correct version of the NTMakefile
2008-06-29 00:30:43 +00:00
Jeffrey Altman
d600d661ad windows-generate-html-cmdref-makefile-20080628
LICENSE MIT

Add a windows makefile to generate the html cmdref from the pod
files.  Requires perl on the build system.
2008-06-29 00:23:48 +00:00
Russ Allbery
62ffbc2a46 remove-administration-reference-20080627
LICENSE IPL10

Purge the old AFS Administration Reference documentation.  This has now
been completely replaced by the manual pages.
2008-06-28 07:32:45 +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
d9dc7e28fe man-page-vldb_convert-20080626
FIXES 104192
LICENSE BSD

New man page for vldb_convert.
2008-06-27 04:29:12 +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
Derrick Brashear
e5f9eba386 doc-nfs-translator-instructions-20080622
LICENSE IPL10
FIXES 103459

clarify instructions for the translator
2008-06-23 04:40:56 +00:00
Russ Allbery
1473a8747a man-page-readme-fileserver-20080605
LICENSE BSD

Remove the note about missing file server options.  We think we got them
all.
2008-06-05 21:19:10 +00:00
Jason Edgecombe
1fdfac7065 man-page-pts-updates-20080605
LICENSE BSD

Add documentation of foreign realm user registration and cross-realm PTS
groups.  Add documentation of missing ptserver flags.  Add some additional
to-do entries for the man pages.
2008-06-05 20:31:13 +00:00
Steven Jenkins
9fbbc3f50c pthreaded-ubik-20080402
LICENSE IPL10

add pthreaded ubik and various binaries
2008-04-02 20:47:27 +00:00
Jason Edgecombe
4bcb7d01b2 man-page-vos-shadow-20080331
LICENSE BSD

Man page for vos shadow.
2008-04-01 07:50:28 +00:00
Jeffrey Hutzelman
ec5a43b086 linux-nfstrans-readme-20080317
LICENSE IPL10

readme for linux nfs translator and extensions
2008-03-17 17:48:35 +00:00
Steven Jenkins
8cad4305ac demand-attach-docs-20080314
LICENSE IPL10

Additional documentation for the demand attach file server, plus a state
diagram.
2008-03-14 18:05:00 +00:00
Steven Jenkins
0e91773fd7 man-page-fileserver-update-20080311
LICENSE IPL10

Update the fileserver documentation for demand-attach and add documentation
of other missing options and notes where some options are only applicable
with particular builds.
2008-03-12 01:28:00 +00:00
Jason Edgecombe
6e18cd4108 man-page-afsd-afsdb-20080308
LICENSE BSD
FIXES 89288 89289

Reference RFC 1183 in the AFSDB documentation.
2008-03-09 05:57:29 +00:00
Derrick Brashear
49d77d8d4b vos-addsite-pod-error-20080220
LICENSE IPL10
Item is not item
2008-02-20 20:18:03 +00:00
Jason Edgecombe
897c360274 man-page-updates-20080219
LICENSE IPL10
FIXES 86677

note 2tb limit, add fs minidump document
2008-02-19 15:25:17 +00:00
Simon Wilkinson
496b5e4c97 pts-localauth-20080204
LICENSE IPL10

distilled from changes by mdw@umich.edu
2008-02-04 19:41:49 +00:00
Simon Wilkinson
98a68f9b02 rxkad-v5-dot-check-20080122
LICENSE IPL10
FIXES 75101

give an option to not enforce the dotted principal check. document it.
2008-01-23 04:13:55 +00:00
Jason Edgecombe
efba39ead0 man-page-fileserver-limits-20080119
LICENSE BSD

Document the 2TB volume and partition limits and the -abortthreshold flag
to the AFS fileserver.
2008-01-20 00:06:49 +00:00
Jason Edgecombe
110d5702ea man-page-cmdebug-updates-20080113
LICENSE BSD

Add -ctime and -cellservdb options to the cmdebug man page and improve
example host names and SEE ALSO references.
2008-01-14 04:55:21 +00:00
Jason Edgecombe
7dc4925cd3 man-page-license-change-20071225
LICENSE BSD

Update man pages submitted by Jason Edgecombe to the BSD license.
2007-12-25 22:22:22 +00:00
Jason Edgecombe
84ef02b0f3 man-page-misc-updates-20071225
LICENSE BSD

Add some additional cross-references, add some missing man pages, fix a
few references to the OpenAFS manuals, document the -live flag to vos
move, and add an example for rxdebug.
2007-12-25 22:15:07 +00:00
Andrew Deason
9f97c5cf74 man-page-fileserver-debug-20071225
LICENSE BSD

The file server debug flag is -d, not -debug.
2007-12-25 22:02:19 +00:00
Derrick Brashear
c2da8a61dd put-relnotes-on-head-20071217
LICENSE IPL10

add 1.4.6 relnotes, put reast on head
2007-12-17 18:02:58 +00:00
Jason Edgecombe
1ee37a57d3 man-page-symlink-20071128
Add man pages for all the symlink commands (Windows-only).
2007-11-29 05:05:37 +00:00
Russ Allbery
6cd96f678e man-page-vos-convertrotorw-fix-20071128
Don't say that inode file servers are only available on Solaris and AIX.
2007-11-29 04:57:05 +00:00
Jason Edgecombe
3be37f4d1c man-page-fs-sysname-improvements-20071128
Update the fs sysname man page to document the behavior of multiple @sys
values.
2007-11-29 04:17:10 +00:00
Jason Edgecombe
f78f007dc5 man-page-fs-rxstatpeer-20071128
New man page for fs rxstatpeer.
2007-11-29 03:54:44 +00:00
Steven Jenkins
a7291b3349 man-page-fileserver-auditlog-20071128
Remove duplicate -auditlog in the fileserver synopsis.
2007-11-29 03:32:52 +00:00
Jason Edgecombe
2ecef5038e man-page-additions-20071128
Add new man pages for vos convertROtoRW, vos copy, and read_tape and add
a troubleshooting section to the fileserver man page.
2007-11-29 03:30:41 +00:00
Russ Allbery
5743116d70 man-fs-uuid-tweaks-20071128
Some minor capitalization and formatting tweaks to the fs uuid man page.
2007-11-29 02:56:13 +00:00
Russ Allbery
e61efde323 man-page-name-underscore-more-20071111
Missed fs apropos when fixing NAME entries to eliminate spaces.
2007-11-12 00:12:28 +00:00
Russ Allbery
6ef9f39335 man-page-name-underscore-20071111
The NAME heading for man pages can't contain a space in the program side
or the man pages won't index with some man implementations.
2007-11-11 22:54:56 +00:00
Derrick Brashear
ed42d1f71a release-notes-1-4-5-20071025
release notes for 1.4.5
2007-10-25 06:19:17 +00:00
Jason Edgecombe
66a19a512e pod-man-fs-uuid-20071023
FIXES 75175

add man page for fs uuid
2007-10-23 17:59:16 +00:00
Russ Allbery
a6fe83d9a6 no-kseal-20070819
Don't build or install kseal by default.  It's a debugging tool with very
limited utility.
2007-08-19 23:04:31 +00:00
Jason Edgecombe
dfb2961b67 man-page-fixes-20070819
More details on how to run check-pod.  Restore the [] markup in the vos
changeloc SYNOPSIS since the flags really are optional.
2007-08-19 23:02:27 +00:00
Jason Edgecombe
fb1cc324a4 man-page-vos-changeloc-more-20070817
Mention vos changeloc in the vos man page.  Also include an incidental fix
to pts source's man page.
2007-08-18 03:28:54 +00:00
Jason Edgecombe
dc5adbeaac man-page-vos-changeloc-20070817
Add a man page for vos changeloc.
2007-08-18 03:24:24 +00:00
Jason Edgecombe
024442b020 man-page-fs-updates-20070817
Add man pages for fs flushall and fs getcalleraccess.
2007-08-18 02:05:42 +00:00
Jason Edgecombe
815ac3c773 man-page-bos-util-20070817
Add a man page for bos_util.
2007-08-18 01:41:39 +00:00
Jason Edgecombe
87efbab4e8 man-page-updates-20070817
Add new man pages for pts interactive, quit, sleep, and source.  Fix POD
errors in a few other man pages and update the to-do list in README.
2007-08-18 00:35:44 +00:00
Jason Edgecombe
a8172fca24 man-page-check-pod-20070817
Add check-pod script to test for POD syntax errors.
2007-08-17 20:57:20 +00:00
Jason Edgecombe
87d2f5cd3f man-page-vos-size-20070805
Add a new man page for vos size.
2007-08-05 22:58:35 +00:00
Jason Edgecombe
e7742db31f man-page-fs-newalias-20070805
Add a new fs newalias man page.  Add -help to the synopsis and options of
the other new man pages.  Add additional missing links in the fs man page.
Fix some wording in the CellAlias man page.
2007-08-05 22:38:10 +00:00
Jason Edgecombe
95cfc0cfaf man-page-fs-listaliases-20070805
Add manual page for fs listaliases.  Also add the links in the fs(1) man
page and update README more for the current to-do list.
2007-08-05 22:16:47 +00:00
Russ Allbery
e735ef962d man-page-style-20070805
Some style fixes and some additional style documentation in README.
2007-08-05 22:08:22 +00:00
Jason Edgecombe
8761673c60 man-page-afsd-crypt-alias-20070805
Complete the documentation of the afsd flags and update a few things like
-settime and -nosettime.  Add man pages for fs setcrypt, fs getcrypt, and
CellAlias.  Based on work by Jason Edgecombe and then extensively edited,
so any errors I probably introduced.
2007-08-05 22:01:42 +00:00
Steven Jenkins
b741b29b4b man-page-demand-attach-20070726
Document additional bos flags for the demand attach file server.
2007-07-26 21:53:42 +00:00
Jason Edgecombe
2367c273bb man-page-updates-20070726
FIXES 65988

Mention aklog and kinit in klog's man page, add -dynroot to the afsd man
page, and mention that -skipauth tells uss not to create any Kerberos
principal and this has to be done separately.
2007-07-26 21:46:46 +00:00
Derrick Brashear
fe61d4e3a1 doc-add-missing-gifs-20070623
FIXES 1826
2007-06-23 15:01:24 +00:00
Russ Allbery
67ea3ae96b man-page-net-info-fixes-20070619
Fix a NetInfo reference in the NetRestrict man page that should be
NetRestrict and add cross-references in SEE ALSO.
2007-06-19 09:55:49 +00:00
Lars Wilke
ee37fd74ef man-fileserver-args-20070611
Add additional arguments to the SYNOPSIS that the file server recognizes.

====================
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.
====================

Missed another erroneous option argument.
2007-06-12 04:49:56 +00:00
Steven Jenkins
ce209b23a5 man-vos-online-20070611
Add initial man pages for vos offline and vos online.
2007-06-12 04:42:01 +00:00
Russ Allbery
707feb4fdd ka-forwarder-licensing-20070508
ka-forwarder is under a different copyright not previously covered, so
embed the actual licensing in the source rather than referring to a file
that doesn't exist and add the relevant information to the LICENSE files.
2007-05-08 23:49:44 +00:00
Russ Allbery
bc585c90cf quickstart-pam-docs-20070507
Flesh out the PAM installation documentation for Linux and Solaris (and a
bit of reformatting in the HP-UX section).
2007-05-07 20:16:02 +00:00
Derrick Brashear
5f919154cf quickstart-solaris-pam-20070423
this actually needs more fleshing out but it's at least a pointer
2007-04-24 04:48:04 +00:00
Simon Wilkinson
f521ac0f60 quickstart-obsolete-appendices-20070423
FIXES 60137

commit updates to the docs for obsolete stuff

====================
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.
====================

also the appendix file
2007-04-24 04:37:52 +00:00
Simon Wilkinson
7de756ca28 quickstart-update-20070410
FIXES 58896

update quickstart guide with new information
2007-04-11 03:14:33 +00:00
Jim Rees
306e23e08c doc-README-20070410
I didn't actually write this, just cribbed it from the openafs-info mailing
list.
2007-04-10 20:52:30 +00:00
Russ Allbery
3960a5ff1c document-fs-setacl-permissions-20070129
Better document the current state of implicit "a" rights on directories.
2007-01-29 19:25:40 +00:00
Russ Allbery
71a1d8a025 docbook-quickguide-cleanup-20061201
Remove generated files from CVS.

====================
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.
====================

Some initial obvious cleanup.  Removed all the sections on Digital UNIX,
changed IBM AFS to OpenAFS throughout, and reformatted and cleaned up the
front matter and some of the first few pages.
2006-12-02 03:56:17 +00:00
Russ Allbery
f544468443 docbook-quickguide-makefile-20061201
Add some comments to the makefile, set up dependencies to build the index
automatically, remove a bunch of unnecessary @-signs in front of commands,
and add a clean target.
2006-12-02 02:22:34 +00:00
Russ Allbery
46cfe72898 aklog-doc-improvements-20061105
Document (at least partially) AFS's mapping of Kerberos v5 principal names
to Kerberos v4 format in the aklog man page.  Also document that -setpag
may not always work.
2006-11-06 04:24:42 +00:00
Russ Allbery
f820125521 afsd-shutdown-doc-improvement-20061105
Change the CAUTIONS about afsd -shutdown to be less dire and more accurate,
as this now mostly works on Linux.
2006-11-06 04:16:09 +00:00
Marcus Watts
f5e9182848 pt_util-man-page-20061005
Initial man page for pt_util.
2006-10-06 06:37:38 +00:00
Chas Williams
52557c982e xml-docbook-documentation-first-pass-20060915
needs more massaging to make it fit the tree, but, get it here first
2006-09-16 01:13:22 +00:00
Russ Allbery
a8e9f2807b man-todo-update-20060803
Update the to-do list for the man pages given the conversion of the aklog
man page to POD and the removal of package and mpp.
2006-08-04 05:06:52 +00:00
Russ Allbery
5c03f31406 rxdebug-man-formatting-20060803
Add missing B<> and S<> markup to the SYNOPSIS.
2006-08-04 04:55:39 +00:00
Russ Allbery
3a34d8cb4f autoconf-likes-relative-paths-20060802
When using the install-sh that ships with the source tree, Autoconf
substitutes in a relative path just to be annoying.  Define the INSTALL
variables in each individual Makefile so that they find the proper file.
Remove the definitions from Makefile.config so that no one will
accidentally get the wrong ones.
2006-08-03 03:37:12 +00:00
Russ Allbery
b57f675bc3 html-man-index-links-20060802
Add links back to the index at the top and bottom of each generated page.
2006-08-03 03:34:35 +00:00
Russ Allbery
b405868ca0 death-to-package-20060801
Remove package, mpp, and wsadmin, along with the remainder of configure
support for obsolete programs and the corresponding documentation.
2006-08-01 23:27:20 +00:00
Russ Allbery
eb1dd3306b we-hate-dce-20060801
Destroy all traces of dauth, including the DCE authentication support in
afsweb.
2006-08-01 21:57:14 +00:00
Russ Allbery
8df5dcbc91 death-to-pinstall-20060801
Delete pinstall and convert the entire tree to use the install program
found by configure (falling back on install-sh in the local tree).  This
means that we have to pre-create directories with install -d.  Also redo
the install and dest rules to be lists of install rules rather than
dependencies driving separate make rules so that running make install will
always update the target directory with the current code, even if there are
files in the install area that are newer.

Stop installing libafssetpag; we're about to kill it in favor of a
different library.  Remove some djgpp rules.
2006-08-01 21:03:54 +00:00
Russ Allbery
cc37bc5ae4 ka-forwarder-20060731
Add ka-forwarder.
2006-07-31 18:34:26 +00:00
Russ Allbery
5f434b8087 aklog-man-page-20060731
Rewrite the aklog man page in POD and add documentation of the new flags
and .xlog.

====================
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.
====================

Fix my misunderstanding of what rxkad2b is.

====================

Fix unterminated B<>.
2006-07-31 17:43:19 +00:00
Russ Allbery
7f219ecd38 autoconf-datarootdir-20060623
Autoconf 2.60 will replace some variables, most notably mandir, with values
relative to datarootdir, a new variable.  Add settings of datarootdir to
the affected files.
2006-06-24 06:14:09 +00:00
Jeffrey Altman
54eed0930a windows-notes-20060604
notes
2006-06-05 02:29:19 +00:00
Jeffrey Altman
67a28f0875 windows-notes-20060424
notes for 1.5.1
2006-04-24 16:00:50 +00:00
Jeffrey Altman
106d23c3ec windows-notes-20060421
updates post 1.5.0
2006-04-21 16:08:17 +00:00
Russ Allbery
b85118420f man-page-fs-listquota-perms-20060410
fs listquota requires read on the directory, not list.
2006-04-10 17:41:22 +00:00
Russ Allbery
5b20ed3511 man-page-asetkey-20060329
Add a man page for asetkey.
2006-03-29 21:44:16 +00:00
Russ Allbery
5f70d9bb3c man-page-kaserver-fix-20060329
SYNOPSIS was mislabelled DESCRIPTION and the man page was therefore missing
the HTML formatting fixes.
2006-03-29 21:00:50 +00:00
Russ Allbery
db8d1da77a man-page-todo-20060322
More to-do items for the documentation.
2006-03-23 05:41:02 +00:00
Russ Allbery
da878c2b9d man-page-bash-bashish-20060308
if ! command is a bashish.  Use if command ; then : ; else instead.
2006-03-08 20:05:59 +00:00
Russ Allbery
fc5acc0151 pretty-html-synopsis-20060228
Implement proper synopsis wrapping for HTML generation.

This was done in three pieces.  First, add HTML-specific tags to the POD to
mark the synopsis for HTML purposes so that we can apply style information
to it.  Second, update the style sheet to indent all lines except for the
first in the synopsis section.  Third, add the appropriate S<> tags around
option and argument pairs so that we don't wrap between the option and its
argument.

Unfortunately, due to the <I<foo>> style that looks nicer for other reasons,
we have to use the very verbose S<<< >>>.  Oh well.
2006-03-01 05:02:29 +00:00
Russ Allbery
fed1cdb022 html-style-todo-20060228
Some style sheet updates and lots of to-do updates based on feedback from
C. Alex North-Keys.
2006-03-01 00:12:52 +00:00
Russ Allbery
6321cca1a5 html-link-fixes-20060228
Make the mentions of subcommands in the fs command introduction links to
the relevant pages, and add to README a to-do note to do this for the rest
of the introductory pages.

Fix links to man pages that contain underscores by working around a bug
in Pod::Simple.
2006-02-28 23:43:03 +00:00
Todd M. Lewis
1705109815 up-m-docs-20060228
Document the -m flag to up.
2006-02-28 23:09:08 +00:00
Chas Williams
9243beff2b pod-updates-20060227
FIXES 26463

update pod files to deal with some section number changes
2006-02-27 20:46:25 +00:00
Derrick Brashear
df0ebd8b90 shut-up-fucking-whiner-20060227
without further comment
2006-02-27 20:17:21 +00:00
Jeffrey Altman
3d1e5e29f7 windows-notes-20060216
1.5.0 development build
2006-02-17 15:35:38 +00:00
Jeffrey Altman
328544bd38 windows-notes-20060214
updates
2006-02-14 13:25:10 +00:00
Russ Allbery
6eb9f473ad man-page-html-20060124
Initial cut at an HTML conversion of the POD reference pages.  Requires
Pod::Simple be installed (version 3.0 or later, probably).  Also fix a POD
formatting bug in the afs(1) man page noticed while testing HTML output.
2006-01-25 05:59:38 +00:00
Jeffrey Altman
1afcbc9441 windows-notes-20060120
more notes for 1.4.1-rc5
2006-01-20 06:22:46 +00:00
Russ Allbery
8863143052 man-page-rxgen-cmdebug-20051227
Add man pages for rxgen and cmdebug.  The cmdebug man page was written from
scratch based on the source code.  The rxgen man page is a conversion of an
old TeX document to POD.
2005-12-27 23:30:22 +00:00
Russ Allbery
90bc5c0092 man-page-misc-improvements-20051221
Add new man pages for livesys and voldump.  Fix the man page for sys to say
what it actually does, rather than implying that it works like livesys, and
to recommend livesys instead.  Fix a path error in the NetInfo
documentation.  Update the README for the current status, including
listing all installed commands that don't have man pages.  (There may still
be some subcommands that don't have man pages but aren't listed.)
2005-12-22 07:34:49 +00:00
Russ Allbery
5fde299434 man-page-installation-20051221
On installation, substitute the configured paths into the man pages,
replacing the Transarc paths.  Also fix a problem with the way that
pinstall was being used to install man pages.  (Silly me, I was assuming
it had the same behavior as install.)

This is just a quick first pass.  Longer term, it's probably better to
replace all paths in the man pages with unambiguous tokens and then
replace those tokens instead of assuming that the man pages use Transarc
paths and replacing those paths specifically.  The current method has a
few minor problems, such as not being able to distinguish between the
various paths that make up /usr/afs/bin.  Still, the results of this method
are good enough to start with.
2005-12-22 07:29:52 +00:00
Russ Allbery
160854bd2b man-page-whitespace-20051220
Remove all trailing whitespace while we have the chance and there are no
merge issues yet.
2005-12-21 00:41:17 +00:00
Russ Allbery
0b21e24d0a man-page-generation-20051220
Move man page generation out into a separate script that's just invoked
from regen.sh, so that someone can run that separate script later if they
wish.  Make that script more robust against problems such as empty podN
directories.  Diagnose a missing pod2man and warn about old versions of
Pod::Man.

Also, remove the old programs used to do the initial conversion from HTML.
Enough post-conversion editing was done that they're no longer necessary
except for historical curiosity, and for that purpose they can be pulled
out of CVS.
2005-12-21 00:37:16 +00:00
Russ Allbery
f64a78e701 man5-editing-pass-20051213
This completes the first editing pass of the man pages.  Very little
content editing has been done, but the server and client versions of
various man pages have been combined into a single man page for the
file (affects CellServDB, ThisCell, NetInfo, and NetRestrict), the
descriptions of the various AFS cache files have been combined into one
afs_cache man page, and the descriptions of the two butc log files have
been combined into one butc_logs man page.

For man pages for databases with two files, symlinks are now created on
installation for the secondary file name.

All of the man pages should now be ready for public review, additional
editing and cleanup, and content editing.
2005-12-14 01:30:20 +00:00
Russ Allbery
ab4abf15fe man8-editing-pass-20051213
This completes the initial editing pass of the section eight man pages.
Only small amounts of content editing has been done.  Some known problems
have been noted in README, but there will doubtless be others, as well as
some lingering formatting problems.  However, the quality should now be
good enough for general public review.

Some of the section eight man pages were really supposed to be section one,
the package apropros and package help commands are too useless to document,
and a few of the difficult-to-name section five man pages have now acquired
names.
2005-12-13 19:21:13 +00:00
Russ Allbery
d60224477f man-page-readme-20051209
Initial documentation for the man page project, including initial notes
on conversion, a start at a formatting guide, information on how to
contribute, and an initial issues list of things I happened to notice
while editing the section one pages.
2005-12-09 16:43:14 +00:00
Russ Allbery
7b5bfb1c17 man-page-reorg-20051209
Generate the man pages in man1, man5, and man8 subdirectories rather than
directly in the doc/man-pages directory to reduce clutter.  Add a
.cvsignore to reduce noise.
2005-12-09 14:50:02 +00:00
Russ Allbery
03b9fcc883 man1-editing-pass-20051209
Complete an initial editing and cleanup pass for all section one man pages.
Fix various conversion problems, formatting inconsistencies, and obvious
problems.  Please note that no editing for content has yet been done; this
is solely editing for formatting and correct conversion to POD.

Also, add some additional section five man pages that were omitted from the
first conversion run due to unusual file names, and globally replace
CAVEATS with CAUTIONS in the man pages to match the original section name.

The section one man pages should now be in reasonable shape and ready for
additional review and further updates, although there are probably still
remaining obvious problems.

====================
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.
====================

This file got the wrong name when it was originally committed.  Fix.
2005-12-09 14:48:56 +00:00
Russ Allbery
e3dfba8e6c man-page-conversion-20051208
This is the initial conversion of the AFS Adminstrators Reference into POD
for use as man pages.  The man pages are now generated via pod2man from
regen.sh so that only those working from CVS have to have pod2man
available.  The Makefile only installs.  The pages have also been sorted
out into pod1, pod5, and pod8 directories, making conversion to the right
section of man page easier without maintaining a separate list and allowing
for names to be duplicated between pod5 and pod1 or pod8 (which will likely
be needed in a few cases).

This reconversion is done with a new script based on work by Chas Williams.
In some cases, the output is worse than the previous POD pages, but this is
a more comprehensive conversion.

This is only the first step, and this initial conversion has various
problems.  In addition, the file man pages that didn't have simple names
have not been converted in this pass and will be added later.  Some of the
man pages have syntax problems and all of them have formatting errors.  The
next editing pass, coming shortly, will clean up most of the remaining
mess.
2005-12-08 12:14:33 +00:00
Rainer Toebbicke
bdc22ef4d3 pod2man-update-20051109
build when there's no pod utils installed
2005-11-09 14:58:29 +00:00
Jeffrey Altman
1b7cbd1211 windows-notes-20051019
updates
2005-10-20 06:09:08 +00:00
Russ Allbery
351a1e3d51 pod-man-pages-20051015
FIXES 19268

add pod generation of man pages
2005-10-15 16:00:57 +00:00
Jeffrey Altman
43693952e7 windows-notes-20051002
changes for 1.4.0 rc6
2005-10-03 01:22:53 +00:00
Jeffrey Altman
f2674a3d45 windows-notes-20050926
more changes for 1.4.0 rc5
2005-09-27 04:13:31 +00:00
Jeffrey Altman
0632bcbdab windows-issues-20050925
update the outstanding issues list
2005-09-26 04:13:16 +00:00
Jeffrey Altman
06c41102b4 windows-notes-20050925
document changes for 1.4 rc5
2005-09-26 04:10:42 +00:00
Jeffrey Altman
da213bfa29 windows-notes-remove-20050925
remove files whose contents are now maintained in the HTML files
src/WINNT/doc/...
2005-09-26 02:10:05 +00:00
Jeffrey Altman
bd1cc3d37b windows-notes-20050914
Add note regarding AFSCache file fragmentation affecting performance

Fix one of the RPC registry entries

Document UUID re-generation change
2005-09-14 05:41:54 +00:00
Jeffrey Altman
9e348b344d windows-fs-flushall-20050907
"fs flushall" is like "fs flushvolume" but flushes all data in the cache

====================
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.
====================

typo
2005-09-07 20:19:10 +00:00
Jeffrey Altman
d154b54b55 windows-uuid-note-20050907
Warn users to remove AFSCache file when cloning machines with AFS installed
2005-09-07 18:17:04 +00:00
Jeffrey Altman
e32a568a96 windows-install-notes-20050904
updated install notes
2005-09-04 05:53:27 +00:00
Jeffrey Altman
d9a958998c windows-updates-20050904
most recent change descriptions
2005-09-04 05:50:17 +00:00
Jeffrey Altman
308ed8fecb windows-notes-20050828
updates
2005-08-28 21:48:25 +00:00
Jeffrey Altman
b9fc404bdf windows-default-trace-log-off-20050827
Now that OAFW is ready for a stable series, we will default "fs trace"
to off on non-Debug builds.   It can be set to on via the TraceOption
registry value.  (see registry.txt)
2005-08-28 04:43:55 +00:00
Jeffrey Altman
48b0320b20 windows-trace-log-to-dbgview-20050820
Added a new option for viewing the trace log data in real time

====================
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.
====================

Include the Thread ID in the output to make it usable for debugging
deadlocks.

====================

alter the afsd_init.log tag for the TraceOption to not be
Windows Event Log specific.
2005-08-26 14:39:31 +00:00
Jeffrey Altman
128ec84945 windows-version-1-5-20050817
Development version to 1.5.xxxx
2005-08-17 11:38:55 +00:00
Jeffrey Altman
adbded1213 windows-version-1-4-20050817
Update version to 1.4.0000   Yay!!!!!
2005-08-17 11:22:50 +00:00