[OpenAFS-Doc] Final (from Latex) pdf's and html's available
ted creedon
tcreedon@easystreet.com
Mon, 27 Jun 2005 16:24:38 -0700
See the Sept 2004 mailing list and the enclosed e-mails with the previous
afs doc manager Renato Arruda.
Renato had a Latex version of all the docs partially done and in cvs. There
were several problems with Renato's sed scripts so html2latex was used
instead...
I suppose I could create diffs and update the Latex cvs archive, if its
still there...
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
Relevant off-line e-mail:
Ted,
I agree that TeX is a lot better for most situations, but when it comes
down to man pages we can either do nroff or go with the info format from
gnu. and i think nroff does the job well. Maybe i should work on getting
them to LaTeX and then write a script to generate the nroff man pages.
I guess i'll just try to finish up this script and familiarize myself
with nroff and then convert the data from html to LaTeX.
What part of the manual you are working on again?
AFS Administrator's Guide
AFS Administration Reference
AFS Quick Start Guide for UNIX
AFS Quick Start Guide for Windows NT/2000 AFS User's Guide
I know i had a couple of those done in CVS, i'm pretty sure about AFS
User's Guide though. I think i had some work on AFS Administrator's Guide,
but I don't really know the status of the AFS Administration Guide.
If you feel it's better to toss out some of that work and start fresh,
i'm ok with that. Most of what's there was built using scripts i wrote
myself which i lost when i lost my $HOME volume.
I've been thinking actually that we could do some research on DocBook.
Maybe we could use it to then generate LaTeX, HTML, PDF, nroff and all sorts
of other file formats. The PHP Project uses it for their documentation and
the result is pretty slick. More info on
http://www.php.net/manual/howto/chapter-docbook.html . I'm not sure we want
to move to it or not, since it could make things overly complex, but it's
something worth looking at.
-Renato
ted creedon wrote:
>Let me send you what I have Wed or thurs.
>
>I think LaTex is a better bet than nroff.
>1. can emit pdf and html
>2. self indexing
>3. variables can be used to set up standard transarc/linux paths 4.
>variables can be used to emit OS specific documents
>
>ted
>
>-----Original Message-----
>From: Renato Arruda [mailto:email@rarruda.org]
>Sent: Sunday, May 23, 2004 4:16 PM
>To: ted creedon
>Subject: Re: AFS Documentation
>
>Hi Ted,
>
>I fired off my new public ssh key to Derrick today. What i had done in
>the past is on:
>
>http://openafs.org/cgi-bin/cvsweb.cgi/openafs-doc/
>
>(But it sure needs improvement, it's just a copy of what's in the HTML
>pages/pdf files, it definetly could use some updating).
>
>Once i get access back i can commit your tex sources too if you wish,
>or you can ask Derrick to get an account to do it yourself.
>
>Which files are you working on? I'd really rather that we don't start
>stepping in each other's toes. Right now i am working on a php script
>to convert the old man pages into a format that linux understands
>(nroff/troff? i forget the exact name). I'm getting the data from
>http://www.openafs.org/pages/doc/AdminReference/auarf002.htm#ToC_54 .
>
>-Renato
>
>ted creedon wrote:
>
>
>
>>It sure wouldn't hurt.
>>
>>I had a 740 page pdf file choke with Adobe and haven't had time to get
>>back to it. The smaller documents work OK though. I'll be back in
>>Portland wed-sun of this week after which I'm in Alaska for a month or 2.
>>
>>
>Fortunately
>
>
>>I have AFS...
>>
>>The intro worked out swell using a variable to include only the Linux
>>sections. You can change the variable to get SUN, AIX or
>>whatever..Printed it 4 pages per sheet double sided. Neat little handbook.
>>
>>Ted
>>
>>-----Original Message-----
>>From: Renato Arruda [mailto:email@rarruda.org]
>>Sent: Friday, May 21, 2004 4:16 PM
>>To: tcreedon@easystreet.com
>>Subject: Re: AFS Documentation
>>
>>Ted,
>>
>> Should i talk to Derrick about trying to get the docs in cvs at
>>openafs.org's server ?
>>
>>-Renato
>>
>>tcreedon@easystreet.com wrote:
>>
>>
>>
>>
>>
>>>I can set up subversion but I'd rather have an institution do it
>>>
>>>Lyx is Latex++ - but I can llive with Latex
>>>
>>>I did insers variables to allow printout of platform specific
>>>manuals, the IBM docs are too bulky to use
>>>
>>>ted
>>>
>>>Original Message:
>>>-----------------
>>>From: Renato Arruda email@rarruda.org
>>>Date: Sat, 17 Apr 2004 18:13:11 -0300
>>>To: tcreedon@easystreet.com
>>>Subject: Re: AFS Documentation
>>>
>>>
>>>Hi Ted,
>>>
>>>Does lyx create good LaTeX, human readable code ? I think we should
>>>definetly use AFS with cvs or something like subversion for the
>>>versioning system (or use a stand-alone cvs or subversion server).
>>>
>>>I'll wait to start until we all figure out what parts of the
>>>documentation to convert and what metodologies we should use.
>>>
>>>-Renato
>>>
>>>
>>>tcreedon@easystreet.com wrote:
>>>
>>>
>>>
-----Original Message-----
From: openafs-doc-admin@openafs.org [mailto:openafs-doc-admin@openafs.org]
On Behalf Of Jeffrey Altman
Sent: Monday, June 27, 2005 3:59 PM
To: ted creedon
Cc: 'Russ Allbery'; openafs-doc@openafs.org
Subject: Re: [OpenAFS-Doc] Final (from Latex) pdf's and html's available
ted creedon wrote:
> I didn't select the format - the users did after a mailing list
discussion.
>
> Anyway, I have documentation that suits my needs and others in the afs
> community. Sounds like there will be 2 or 3 source formats to keep in
sync.
>
> Feel free to produce what you will. I have something I can edit and
> will share it with the community either on SourceForge or elsewhere if
> not on the afs site.
>
> Keep me posted about content changes.
>
> tedc
Ted:
Can you please point me at the mailing list discussion that resulted in the
consensus to use laTex?
Jeffrey Altman