Commit Graph

337 Commits

Author SHA1 Message Date
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