272 Commits

Author SHA1 Message Date
Russ Allbery
e43fdb4c7f STABLE14-doc-xml-build-cvsignore-20090601
LICENSE BSD

Ignore new generated files from the documentation build.


(cherry picked from commit e34fe0f9a85c0fa965fe30ead4c5ba14d077268f)
2009-06-01 23:51:31 +00:00
Russ Allbery
080078c318 STABLE14-doc-xml-version-depends-20090601
LICENSE BSD

Make PDF manual generation also depend on version.xml, matching HTML
generation.


(cherry picked from commit 2520cc9aabef8877cdd99abb858dc011dfa5629f)
2009-06-01 23:41:04 +00:00
Jeffrey Altman
1aaddd3922 STABLE14-doc-doxygen-20090531
LICENSE BSD

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

Funded under an SBIR grant.


(cherry picked from commit 5526ba218f7f3653cabe5423b25b82f0241b0abc)
2009-05-31 17:54:53 +00:00
Douglas Engert
50d079ea8a STABLE14-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


(cherry picked from commit 74df876dafb9cf80ab5a8099b4202f2205bd9791)
2009-05-31 02:23:11 +00:00
Derrick Brashear
41e3e1d446 STABLE14-xml-doc-building-glue-20090527
LICENSE IPL10
FIXES 124804

add configure switches for building docs. generate version files needed.


(cherry picked from commit e452c704c59700496227dccb3161efd34ca709ba)
2009-05-27 20:45:07 +00:00
Russ Allbery
8a3171ba68 STABLE14-man-page-vos-dump-flags-20090526
LICENSE BSD

Add documentation of the -clone and -omitdirs flags to vos dump.


(cherry picked from commit 4c7a7f343c6cb0c5e6def6d28649cea65ff2907e)
2009-05-27 02:25:36 +00:00
Jeffrey Altman
a65443b26a STABLE14-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.


(cherry picked from commit e4b36071ef35b73fb68db6c054e811ba7e6b65e0)
2009-05-21 18:56:28 +00:00
Derrick Brashear
c3f6d753b3 STABLE14-krb-conf-manpage-path-fix-20090519
LICENSE IPL10

fix path to krb.conf, per IRC discussion


(cherry picked from commit 6cc155e8da8f505443f43a312a522a64c52515e8)
2009-05-19 19:40:48 +00:00
Russ Allbery
716bf5fd35 STABLE14-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.


(cherry picked from commit 7b56f2ebfc8c2e1695e007798833ad2053e08113)
2009-05-19 05:00:09 +00:00
Russ Allbery
2c8d62e459 STABLE14-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*.


(cherry picked from commit 74585aa5003cfb42103ac8d6059137eebd2005e0)
2009-05-19 04:29:48 +00:00
Russ Allbery
6a0f86c3c3 STABLE14-man-page-syntax-errors-20090518
LICENSE BSD

Fix some man page syntax errors that snuck into the recent round of
updates.


(cherry picked from commit 9ad6c37ccfec016df9e845972ae626a1da19dfbf)
2009-05-19 00:57:18 +00:00
Steven Jenkins
268eec3b55 STABLE14-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.


(cherry picked from commit 798ffe54af1f5798bf07947439fc62946bc2f07e)
2009-05-19 00:38:24 +00:00
Steven Jenkins
cfedde7ada STABLE14-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.


(cherry picked from commit 6df60468130977744fea0499fba2351ef74175d8)
2009-05-19 00:37:16 +00:00
Steven Jenkins
6f7a2f1933 STABLE14-man-page-vsys-20090518
LICENSE BSD
FIXES 124793

Add man page for vsys.


(cherry picked from commit 1df9282985949b38313f05640d9afd05948f45c4)
2009-05-19 00:35:43 +00:00
Steven Jenkins
4aa97e3f32 STABLE14-man-page-rmtsysd-20090518
LICENSE IPL10
FIXES 124792

New man page for rmtsysd.


(cherry picked from commit 921774594faead45f9432af218c5f9f394a03204)
2009-05-19 00:35:12 +00:00
Steven Jenkins
718fc313d3 STABLE14-man-page-restorevol-20090518
LICENSE IPL10
FIXES 124791

Add man page for restorevol.


(cherry picked from commit 97b0d230145c4c5f58ef785b11bf2d201ded2d26)
2009-05-19 00:34:40 +00:00
Steven Jenkins
95086c6a72 STABLE14-man-page-fs-monitor-20090518
LICENSE IPL10
FIXES 124790

Add man page for fs monitor.


(cherry picked from commit 01ba5ab1ed24d14c1068d5dac951cbea1befba10)
2009-05-19 00:33:52 +00:00
Steven Jenkins
e494a4c7ea STABLE14-man-page-copyauth-20090518
FIXES 124789
LICENSE IPL10

Add man page for copyauth.


(cherry picked from commit a7a80efd577d9f2a9573fe35c12ca30b59e2f375)
2009-05-19 00:33:32 +00:00
Steven Jenkins
3e970378c5 STABLE14-man-page-compile-et-20090518
LICENSE IPL10
FIXES 124788

Add man page for compile_et.


(cherry picked from commit 16ec87e0b382bc8bca14ec6a70987f54899eea7f)
2009-05-19 00:33:15 +00:00
Mike Robinson
0c616c7252 STABLE14-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.


(cherry picked from commit faf518ace7c8c0ec9c3269afd267afd276d69cd4)
2009-05-18 04:41:11 +00:00
Steven Jenkins
750772838f STABLE14-man-page-more-fs-commands-20090517
LICENSE IPL10
FIXES 124756

Add man pages for fs cscpolicy, fs getfid, and fs memdump.


(cherry picked from commit 32c93cf55210809de92e81428bff784b07a58d44)
2009-05-18 04:40:37 +00:00
Simon Wilkinson
83c312c177 STABLE14-man-pod-fileserver-20090515
LICENSE IPL10
FIXES 124778

-L sets the max number of threads


(cherry picked from commit d5c2efa499fdef6811e40e79a041a43761b3d208)
2009-05-15 14:30:49 +00:00
Jeffrey Altman
9d5b51fa98 STABLE14-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

RCS file: /cvs/openafs/doc/xml/UserGuide/Attic/a3632.html,v
Working file: doc/xml/UserGuide/a3632.html
head: 1.2
branch:
locks: strict
access list:
keyword substitution: kv
total revisions: 7;	selected revisions: 0
description:

RCS file: /cvs/openafs/doc/xml/UserGuide/Attic/a3812.html,v
Working file: doc/xml/UserGuide/a3812.html
head: 1.2
branch:
locks: strict
access list:
keyword substitution: kv
total revisions: 7;	selected revisions: 0
description:

RCS file: /cvs/openafs/doc/xml/UserGuide/Attic/book1.html,v
Working file: doc/xml/UserGuide/book1.html
head: 1.2
branch:
locks: strict
access list:
keyword substitution: kv
total revisions: 7;	selected revisions: 0
description:

RCS file: /cvs/openafs/doc/xml/UserGuide/Attic/c1095.html,v
Working file: doc/xml/UserGuide/c1095.html
head: 1.2
branch:
locks: strict
access list:
keyword substitution: kv
total revisions: 7;	selected revisions: 0
description:

RCS file: /cvs/openafs/doc/xml/UserGuide/Attic/c113.html,v
Working file: doc/xml/UserGuide/c113.html
head: 1.2
branch:
locks: strict
access list:
keyword substitution: kv
total revisions: 7;	selected revisions: 0
description:

RCS file: /cvs/openafs/doc/xml/UserGuide/Attic/c1444.html,v
Working file: doc/xml/UserGuide/c1444.html
head: 1.2
branch:
locks: strict
access list:
keyword substitution: kv
total revisions: 7;	selected revisions: 0
description:

RCS file: /cvs/openafs/doc/xml/UserGuide/Attic/c2454.html,v
Working file: doc/xml/UserGuide/c2454.html
head: 1.2
branch:
locks: strict
access list:
keyword substitution: kv
total revisions: 7;	selected revisions: 0
description:

RCS file: /cvs/openafs/doc/xml/UserGuide/Attic/c3402.html,v
Working file: doc/xml/UserGuide/c3402.html
head: 1.2
branch:
locks: strict
access list:
keyword substitution: kv
total revisions: 7;	selected revisions: 0
description:

RCS file: /cvs/openafs/doc/xml/UserGuide/Attic/c569.html,v
Working file: doc/xml/UserGuide/c569.html
head: 1.2
branch:
locks: strict
access list:
keyword substitution: kv
total revisions: 7;	selected revisions: 0
description:

RCS file: /cvs/openafs/doc/xml/UserGuide/Attic/f24.html,v
Working file: doc/xml/UserGuide/f24.html
head: 1.2
branch:
locks: strict
access list:
keyword substitution: kv
total revisions: 7;	selected revisions: 0
description:

RCS file: /cvs/openafs/doc/xml/UserGuide/Attic/g4153.html,v
Working file: doc/xml/UserGuide/g4153.html
head: 1.2
branch:
locks: strict
access list:
keyword substitution: kv
total revisions: 7;	selected revisions: 0
description:

RCS file: /cvs/openafs/doc/xml/UserGuide/Attic/i4608.html,v
Working file: doc/xml/UserGuide/i4608.html
head: 1.2
branch:
locks: strict
access list:
keyword substitution: kv
total revisions: 7;	selected revisions: 0
description:

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


(cherry picked from commit 9e8e080a5c1281dfa6109700cacd13cd1c44f5ef)
2009-05-14 03:30:06 +00:00
Derrick Brashear
5ba0b7e1e2 STABLE14-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.


(cherry picked from commit 6ba44802ea6cf722c22a4784cbbad70ed6f5d60a)
2009-05-12 20:40:57 +00:00
Chas Williams
97fb0c9479 STABLE14-xml-docbook-documentation-first-pass-20060915
needs more massaging to make it fit the tree, but, get it here first


(cherry picked from commit 52557c982e1ed65c694c5c1387ac2b385356438d)
2009-05-11 16:12:14 +00:00
Derrick Brashear
66dd365571 STABLE14-man-pages-allow-dots-consistent-20090505
LICENSE IPL10

make all server man pages list -allow-dotted-principals (rather than
-allow-dotted-principal)


(cherry picked from commit c8ac7d1c499150b3f82a6566e9bbdb7478ddd469)
2009-05-05 13:30:45 +00:00
Jason Edgecombe
5a9828b71b STABLE14-netinfo-fake-address-text-20090427
LICENSE IPL10
FIXES 124699

explain fake address support for NetInfo files


(cherry picked from commit 758366c26a0d1b2e97449ab858e15da8cc0d73f0)
2009-04-27 19:37:44 +00:00
Derrick Brashear
157e3374bb STABLE14-dynamic-vcache-allocation-20090319
LICENSE IPL10
FIXES 124334

add dynamic allocation of vcaches when possible (currently just for linux)


(cherry picked from commit e59b81c984652f7570708831d8b36bdd42f98cf8)
2009-03-20 02:32:56 +00:00
Jason Edgecombe
b4070fe233 STABLE14-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.


(cherry picked from commit 85bb464bb46cd87e10a90b75748e164ae683cba0)
2009-03-17 02:38:35 +00:00
Steven Jenkins
4f81e0be85 STABLE14-vldb-check-meaningful-return-codes-20090216
LICENSE IPL10
FIXES 124321

make vldb_check have meaningful return codes


(cherry picked from commit 43bcfaf9cc429cec51a98857d86d870c45759baa)
2009-02-17 04:17:22 +00:00
Russ Allbery
75e3325997 STABLE14-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.


(cherry picked from commit d4763404655e27098eb4340eca8777b63d8a5847)
2009-02-02 01:23:16 +00:00
Russ Allbery
d47c223bc7 STABLE14-man-page-vos-examine-copy-date-20090201
LICENSE BSD

Document the Copy field of vos examine output.


(cherry picked from commit f204e4e37f39fa15beabf68e68dce1f6425f7513)
2009-02-02 01:22:43 +00:00
Jason Edgecombe
32202429ec STABLE14-man-page-pts-membership-fixes-20090119
FIXES 124157
LICENSE BSD

More wording and typo fixes for the pts membership man page.


(cherry picked from commit 8c18c62dffa23557fb521950eede4252cdafc0b5)
2009-01-19 23:05:07 +00:00
Russ Allbery
03fb12e1fa STABLE14-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.


(cherry picked from commit d781450cf3c08bf89f3d1490620ed89885f7e518)
2009-01-19 03:46:53 +00:00
Derrick Brashear
4def412a79 STABLE14-netrestrict-no-wildcard-20090106
LICENSE IPL10

don't misadvertise network wildcard support


(cherry picked from commit 80fc888a9223050481de932233fe7121a48df194)
2009-01-06 13:40:27 +00:00
Russ Allbery
79a4377c6a STABLE14-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.


(cherry picked from commit a3c9b01f3adae098dbd31e7b9742dec5f8081d2c)
2008-11-12 02:31:21 +00:00
Jason Edgecombe
2ece563297 STABLE14-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.


(cherry picked from commit 794967ed3ec5a46329375ae19eac21c1c508c1ee)
2008-11-12 02:19:48 +00:00
Russ Allbery
95cfc001d5 STABLE14-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.


(cherry picked from commit 196e995b2569c7dceea8748a36431802d4875188)
2008-11-12 02:02:44 +00:00
Derrick Brashear
b8841f1226 STABLE14-syncserv-syncvldb-manpages-dryrun-20080906
LICENSE IPL10

make syncserv and syncvldb manpages reflect dryrun option


(cherry picked from commit 4119d9742b3e17fac6a3f1f7ab64ec829f085498)
2008-09-06 12:51:38 +00:00
Derrick Brashear
86a6e4e82f STABLE14-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


(cherry picked from commit 12c8abc69030d3368194b148c692215c61b5da9c)
2008-08-25 02:15:18 +00:00
Russ Allbery
0bbbd05dbf STABLE14-man-page-html-index-underscores-20080713
LICENSE BSD

Remove underscores from the anchor in the index for all section 5 manual
pages.


(cherry picked from commit 6a322e4eb7e79896e3322e0ace16a6ed99668162)
2008-07-14 03:30:55 +00:00
Russ Allbery
1112a44af3 STABLE14-html-man-index-links-20060802
Add links back to the index at the top and bottom of each generated page.


(cherry picked from commit b57f675bc3364c17fccc58ed56307f91213d3b3d)
2008-07-14 03:04:08 +00:00
Russ Allbery
6a3ab81cf0 STABLE14-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.


(cherry picked from commit 2a92f43987cd08dc0134b775e0d118894d22d3e5)
2008-07-14 02:56:20 +00:00
Jason Edgecombe
c8e7bba82c STABLE14-docs-ticket-104110-20080713
LICENSE BSD
FIXES 104110

add krb.conf

update CellServDB to discuss AFSDB DNS records


(cherry picked from commit 298fb5ce52f3f5296c24ed1300287b5fa5870a3c)
2008-07-14 00:57:24 +00:00
Jeffrey Altman
380b5e8c41 STABLE14-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.


(cherry picked from commit df9f2455fbe34ac105179797f85aacc63a8b8da8)
2008-07-12 07:02:27 +00:00
Russ Allbery
8b1a7a2139 STABLE14-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.


(cherry picked from commit 9b61f58fa78259eb092350599a0a26d75ac14fa8)
2008-07-01 00:12:31 +00:00
Russ Allbery
f8623fba39 STABLE14-man-page-vos-convertROtoRW-inode-20080630
LICENSE BSD

vos convertROtoRW can now be used with an inode file server.  Adjust the
man page accordingly.


(cherry picked from commit 6331d37125428956586610b8e514e1b304a16022)
2008-06-30 21:22:06 +00:00
Russ Allbery
1730718f22 STABLE14-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.


(cherry picked from commit cf816d535a60a7a5f7efa5564b647ee87e33b7d7)
2008-06-30 21:09:40 +00:00
Russ Allbery
29617c0210 STABLE14-install-and-document-klog-krb5-20080627
LICENSE IPL10

Install the Kerberos v5 klog as klog.krb5 and install a man page for it.


(cherry picked from commit 3b273dd55291b28c698990001370a97c413c2673)
2008-06-28 08:19:05 +00:00
Russ Allbery
ae95f78d09 STABLE14-remove-administration-reference-20080627
LICENSE IPL10

Purge the old AFS Administration Reference documentation.  This has now
been completely replaced by the manual pages.


(cherry picked from commit 62ffbc2a464521eeee4c244d2555c316dfae180f)
2008-06-28 07:41:28 +00:00