Date: Fri, 13 Dec 2002 08:37:59 +0100 From: Szilveszter Adam <sziszi@bsd.hu> To: Jeremy Brown <jeremy@guero.com> Cc: freebsd-doc@FreeBSD.ORG Subject: Re: offer to mirror handbook and other docs Message-ID: <20021213073758.GB840@fonix.adamsfamily.xx> In-Reply-To: <Pine.BSF.4.44.0212130310550.33018-100000@guero.com> References: <Pine.BSF.4.44.0212130310550.33018-100000@guero.com>
next in thread | previous in thread | raw e-mail | index | archive | help
Hello, On Fri, Dec 13, 2002 at 03:26:51AM +0000, Jeremy Brown wrote: > > Hi, > > I would like to offer to mirror the FreeBSD handbook on my site. Is there > a problem with providing this on my site? It will maintain all copyrights > and information of your project. I wanted to make sure it was okay to > provide this. The reason being my hosting provider has many standard > features but not all of them are available so I would have a separate > tables of contents that includes topics that do work on the server. Please > let me know what I have to do to be able to provide this. I think there are no problems with you providing a copy of the Handbook at your website, if you read and observe the copyright notice which is in the front of the book. As for the technical part. There are two ways open for you: - You want to quickly get a copy in HTML format. For this, you can ftp to ftp.freebsd.org, go to the directory pub/FreeBSD/doc/handbook (if you want the English version) and download the html version (or any other format you like), unpack it on the web server and there you go. You will usually find a recent version here, but sometimes, when there are problems with the automated update process, it possible that it lags behind. This method is quick and easy. - You want more control over the whole, or want to build it yourself just to be sure that it is the most recent version. For this, you will need a FreeBSD system, and a bunch of tools that you can install in one go by installing the textproc/docproj port. If you do not need formats like PS and PDF, you can safely say JADETEX=no for the installation, which will save you quite a bit of downloading and also configuration. If you need PS and/or PDF, or you already have LaTeX configured on the build system, you can just say JADETEX=yes, and follow the instructions that the install will give you. In any case, after the installation, you should check out /usr/share/examples/cvsup/doc-supfile, and use it with cvsup to get a copy of the documentation sources. (You can edit it to not include languages other than English if you do not need it). This will get you the sources not only for the Handbook, but the other documentation from the The FreeBSD Documentation Project as well, you might also find some of them interesting. If you prefer CVS, you can also use that to get the sources. In any event, after you have got the documentation souces (which are in Docbook), you just cd to the directory doc/en_US.ISO8859-1/books/handbook and say "make" there. It should now build many HTML files from the sources, these files make up the Handbook. After that, a "make install" will copy them (by default) to /usr/share/doc/en_US.ISO8859-1/books/handbook, but you can edit the Makefile to use the directory where your web docs are. It is not difficult, but may take some time depending on the system firepower you have since the Handbook is rather large. After this, you can from time to time run cvsup (or CVS) again, to refresh the sources and again "make" and "make install" the new version of the Handbook. If you would like more information, you can also read the FreeBSD Documentation Project Primer, which is either at: http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/ or you can cd to doc/en_US.ISO8859-1/books/fdp-primer after downloading the doc sources as above and say "make" there, will work too. > I am also interested in helping with the docs. Do you have a list of > possible topics that I could choose some that interest me. For first ideas, you should read the The FreeBSD Documentation Project Primer referenced above, and you can look at some on-goin projects at http://www.freebsd.org/docproj/index.html Also, if you think there is something that is missing, or outdated or wrong or not understandable in the existing documentation, you should not hesitate to bring it forward. If you get the doc sources, you can directly prepare patches in Docproj as well (do not worry, if you cannot write in Docbook, your suggestions will still be reviewed, and learning Docbook over time is not difficult, the The FreeBSD Documentation Project Primer can help you with that), and then use send-pr to send them for inclusion (be sure to use the docs category). Also, it is a good idea to subscribe to this mailing list, since this the place where documentation related questions will be addressed. Welcome you aboard, and thank you for your interest in helping FreeBSD to become even more useable! Hope you will have a lot of fun. We are looking forward to receive your contributions. If you have any questions, feel free to ask them on this list! -- Regards: Szilveszter ADAM Szombathely Hungary To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20021213073758.GB840>