Commit Graph

157 Commits

Author SHA1 Message Date
Marcus Watts
f5e9182848 pt_util-man-page-20061005
Initial man page for pt_util.
2006-10-06 06:37:38 +00:00
Chas Williams
52557c982e xml-docbook-documentation-first-pass-20060915
needs more massaging to make it fit the tree, but, get it here first
2006-09-16 01:13:22 +00:00
Russ Allbery
a8e9f2807b man-todo-update-20060803
Update the to-do list for the man pages given the conversion of the aklog
man page to POD and the removal of package and mpp.
2006-08-04 05:06:52 +00:00
Russ Allbery
5c03f31406 rxdebug-man-formatting-20060803
Add missing B<> and S<> markup to the SYNOPSIS.
2006-08-04 04:55:39 +00:00
Russ Allbery
3a34d8cb4f autoconf-likes-relative-paths-20060802
When using the install-sh that ships with the source tree, Autoconf
substitutes in a relative path just to be annoying.  Define the INSTALL
variables in each individual Makefile so that they find the proper file.
Remove the definitions from Makefile.config so that no one will
accidentally get the wrong ones.
2006-08-03 03:37:12 +00:00
Russ Allbery
b57f675bc3 html-man-index-links-20060802
Add links back to the index at the top and bottom of each generated page.
2006-08-03 03:34:35 +00:00
Russ Allbery
b405868ca0 death-to-package-20060801
Remove package, mpp, and wsadmin, along with the remainder of configure
support for obsolete programs and the corresponding documentation.
2006-08-01 23:27:20 +00:00
Russ Allbery
eb1dd3306b we-hate-dce-20060801
Destroy all traces of dauth, including the DCE authentication support in
afsweb.
2006-08-01 21:57:14 +00:00
Russ Allbery
8df5dcbc91 death-to-pinstall-20060801
Delete pinstall and convert the entire tree to use the install program
found by configure (falling back on install-sh in the local tree).  This
means that we have to pre-create directories with install -d.  Also redo
the install and dest rules to be lists of install rules rather than
dependencies driving separate make rules so that running make install will
always update the target directory with the current code, even if there are
files in the install area that are newer.

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

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

Fix my misunderstanding of what rxkad2b is.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Fix one of the RPC registry entries

Document UUID re-generation change
2005-09-14 05:41:54 +00:00