Commit Graph

354 Commits

Author SHA1 Message Date
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
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
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
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
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
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
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
Russ Allbery
e6f6c3493e Fixes and clarifications to vos setaddrs man page
Add a caution explaining how the file server addresses are registered
and pointing users at NetInfo and NetRestrict plus restarting the file
server for the normal case.

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

Reference vos listaddrs -printuuid specifically to get the UUID.

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

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

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

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

Change-Id: I4fe1cd131cd334386bc16ce733e01e29e0511d4f
Reviewed-on: http://gerrit.openafs.org/1600
Reviewed-by: Andrew Deason <adeason@sinenomine.net>
Tested-by: Andrew Deason <adeason@sinenomine.net>
Reviewed-by: Simon Wilkinson <sxw@inf.ed.ac.uk>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-04-08 11:23:26 -07:00
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
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
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
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
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
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
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
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
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
Andrew Deason
fee0efedc1 Formatting typo in vos_setfields manpage
The POD formatting code for bold is B, not b.

Reviewed-on: http://gerrit.openafs.org/546
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-09-28 08:25:25 -07:00
Russ Allbery
fdea6a3418 Windows: update build system for restorevol man page move
restorevol moved from section 8 to section 1.  The Windows build
system needed corresponding changes.

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

Reviewed-on: http://gerrit.openafs.org/333
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2009-09-09 21:22:34 -07:00
Russ Allbery
5dd137c474 Turn on --enable-bos-new-config unconditionally
Remove the conditional and Autoconf flag for enabling BosConfig.new
handling and change bosserver to always rename BosConfig.new to BosConfig
on startup if the former exists.

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

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

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

LICENSE BSD

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

Reviewed-on: http://gerrit.openafs.org/327
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-08-20 12:11:13 -07:00
Russ Allbery
5a4f31090f Restore permission documentation in bosserver man page
The original IBM HTML documentation had a table showing the permissions
that bosserver expects and sets when it creates the directory structure
for AFS.  That table was accidentally dropped in the conversion to POD.
Restore it from the HTML shipped with an older version of OpenAFS.

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

LICENSE BSD

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

LICENSE BSD

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

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

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

FIXES 124674

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

Reviewed-on: http://gerrit.openafs.org/157
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
2009-07-24 12:29:30 -07:00
Jeffrey Altman
ab27eb24af Windows: rename compile_et.pod to afs_compile_et.pod
Gerrit 175 renamed compile_et and compile_et.pod to afs_compile_et*.
Fix the Windows build system to process the new pod file name
and modify the WiX installer scripts to install afs_compile_et.html.

FIXES 125152

LICENSE MIT

Reviewed-on: http://gerrit.openafs.org/http://gerrit.openafs.org/204
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
2009-07-23 13:48:25 -07:00
Simon Wilkinson
c321cb4672 Rename installed version of compile_et
Rename the installed version of compile_et to afs_compile_et to avoid
conflicts with other, more standard, users of com_err. Also rename the
man page to match

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

Reviewed-on: http://gerrit.openafs.org/11
Verified-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Russ Allbery <rra@stanford.edu>
2009-07-08 15:18:03 -06:00
Jason Edgecombe
002363adb9 Fixed a minor grammatical error in the voz_zap man page
Reviewed-on: http://gerrit.openafs.org/7
Verified-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Russ Allbery <rra@stanford.edu>
2009-07-06 19:47:03 -06:00
Simon Wilkinson
d5081f264d Remove CVS ignore files
Now we're in git we don't need any cvsignore files any more...

Reviewed-on: http://gerrit.openafs.org/1
Verified-by: Derrick Brashear <shadow@gmail.com>
Reviewed-by: Derrick Brashear <shadow@gmail.com>
2009-07-06 11:03:16 -06:00
Jeffrey Altman
4db337f87c manpages-fs-chown-chgrp-20090701
LICENSE BSD

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

Update titles for Windows only commands to indicate they are Windows only.
2009-07-01 22:12:10 +00:00
Simon Wilkinson
c41a467741 gitignore-20090615
LICENSE IPL10

make gitignore files
2009-06-15 23:29:29 +00:00
Mike Meffie
394243f3ae man-page-xstat-fs-test-20090608
LICENSE IPL10
FIXES 124905

Document xstat_fs_test collection 3, which returns callback statistics
from the file server (useful for tuning).
2009-06-08 23:39:51 +00:00
Jeffrey Altman
5bd88cfa6b doc-man-pages-windows-20090607
LICENSE MIT

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

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

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

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

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

afsd man page update required and will follow.

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

man page update to document previous work
2009-05-31 02:22:24 +00:00
Russ Allbery
4c7a7f343c man-page-vos-dump-flags-20090526
LICENSE BSD

Add documentation of the -clone and -omitdirs flags to vos dump.
2009-05-27 02:21:45 +00:00
Jeffrey Altman
4a523957fe windows-doc-man-dependency-20090525
LICENSE IPL10

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

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

fix path to krb.conf, per IRC discussion
2009-05-19 19:40:09 +00:00
Russ Allbery
9ad6c37ccf man-page-syntax-errors-20090518
LICENSE BSD

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

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

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

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

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

New man page for rmtsysd.
2009-05-18 21:22:04 +00:00
Steven Jenkins
97b0d23014 man-page-restorevol-20090518
LICENSE IPL10
FIXES 124791

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

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

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

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

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

Add man pages for fs cscpolicy, fs getfid, and fs memdump.
2009-05-18 03:50:00 +00:00
Simon Wilkinson
d5c2efa499 man-pod-fileserver-20090515
LICENSE IPL10
FIXES 124778

-L sets the max number of threads
2009-05-15 14:30:07 +00:00
Derrick Brashear
6ba44802ea pts-encrypt-option-20090512
LICENSE IPL10
FIXES 124681

add -encrypt flag to pts generic options, allowing the wire to be
encrypted if desired and the user's authenticated. document same.
2009-05-12 20:40:20 +00:00
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
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
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
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
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
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
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
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
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
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
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
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
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
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