[OpenAFS] RE: AFS Documentation

ted creedon tcreedon@easystreet.com
Mon, 5 Jan 2004 08:41:55 -0800


I have the TEX Quick Start Unix Guide mostly corrected, The User's guide =
is
readable and the Admin Guide needs some straightforward work.

The most prevalent problem is the use of \texttt{} inside =
\begin{verbatim}
clauses. Verbatim composed exactly as typed in typewriter font and is =
used
for displaying command and option names, however variable names in =
italic
are not used. (Ref. para 1.5 Typographical Conventions).

There is a choice to either remove the \tedxtt{} or use the alltt =
package
which recognizes \textt{}.=20

The only reason not removing \textt would be to replace it with \emph{}
(italics) to match the IBM version, however if you're cut and pasting =
from
the documentation to the command line italics are useless.

By using \begin{comment} .. \end{comment} clauses the Linux version of =
the
Quick Start is 79 pp long and easy to read.

Does anyone have any preferences?

Anyone care to proof the manuals?

tedc


-----Original Message-----
From: openafs-info-admin@openafs.org =
[mailto:openafs-info-admin@openafs.org]
On Behalf Of ted creedon
Sent: Thursday, January 01, 2004 5:08 PM
To: openafs-info@openafs.org
Subject: RE: [OpenAFS] RE: AFS Documentation

It would be nice if the html pages were sourced from the TEX files.

A well written summary of the recent heimdal/krb5 klog/aklog/kinit
discussions really ought to be included as updates.

I've managed to recompile the SuSE sources - they have a diff file with
their standard directory changes which conflicts with the
--enable-transarc-paths switch. The transarc paths are handy if you're
trying to get something running  by following the IBM documentation for =
the
first time.

-tedc

-----Original Message-----
From: openafs-info-admin@openafs.org =
[mailto:openafs-info-admin@openafs.org]
On Behalf Of Renato Arruda
Sent: Thursday, January 01, 2004 7:41 AM
To: ted creedon
Cc: openafs-info@openafs.org
Subject: Re: [OpenAFS] RE: AFS Documentation

This was done a while ago, and i dont recall the exact status of each=20
file, but it might be worth taking a look.

http://www.openafs.org/cgi-bin/cvsweb.cgi/openafs-doc/

-Renato
ted creedon wrote:
> Is the documentation available in other than html format, i.e. Tex or
> something printable?
>=20
>=20
> _______________________________________________
> OpenAFS-info mailing list
> OpenAFS-info@openafs.org
> https://lists.openafs.org/mailman/listinfo/openafs-info


_______________________________________________
OpenAFS-info mailing list
OpenAFS-info@openafs.org
https://lists.openafs.org/mailman/listinfo/openafs-info

_______________________________________________
OpenAFS-info mailing list
OpenAFS-info@openafs.org
https://lists.openafs.org/mailman/listinfo/openafs-info