Difference between revisions of "FPCDocs Tutorial"
From Lazarus wiki
Jump to navigationJump to search (category) |
(→Prerequisites: git instead of svn) |
||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 9: | Line 9: | ||
* A working FreePascal environment must be installed (e.g. a stable version from a Debian repository). See [1] for more details. | * A working FreePascal environment must be installed (e.g. a stable version from a Debian repository). See [1] for more details. | ||
* Having a working Lazarus installed may not hurt | * Having a working Lazarus installed may not hurt | ||
| − | * As the documentation needs FPC source files, you will need the latest source from | + | * As the documentation needs FPC source files, you will need the latest source from git. See [1] on how to get that. |
| − | * Some tex programs: texlive, tex4ht, and dvi2tty if you want to generate plain-text documents (for DOS, mainly). The package names may differ depending on your distribution. | + | * The fpcdocs: |
| + | <syntaxhighlight lang="bash"> | ||
| + | svn co http://svn.freepascal.org/svn/fpcdocs/trunk fpcdocs | ||
| + | </syntaxhighlight> | ||
| + | * Some tex programs: texlive, tex4ht, and dvi2tty if you want to generate plain-text documents (for DOS, mainly). The package names may differ depending on your distribution. The files a4.sty and moveverb.sty. | ||
| + | **Ubuntu 12: <syntaxhighlight lang="bash">apt-get install tex4ht texlive-binaries texlive-latex-base texlive-latex-recommended texlive-latex-extra</syntaxhighlight> | ||
=== Assumptions === | === Assumptions === | ||
| Line 16: | Line 21: | ||
Also, this tutorial assumes you have a stable system-wide installation of FPC and Lazarus, and a working SVN version of FPC with proper fpc.cfg. | Also, this tutorial assumes you have a stable system-wide installation of FPC and Lazarus, and a working SVN version of FPC with proper fpc.cfg. | ||
Finally, you have your SVN FPC source and fpcdocs directories set up like this: | Finally, you have your SVN FPC source and fpcdocs directories set up like this: | ||
| − | <bash> | + | <syntaxhighlight lang="bash"> |
~/fpc/ | ~/fpc/ | ||
| − | ~/fpc/ | + | ~/fpc/fpcdocs #contains SVN http://svn.freepascal.org/svn/fpcdocs/trunk |
| − | ~/fpc/ | + | ~/fpc/fpcsrc #contains FPC sources, e.g. http://svn.freepascal.org/svn/fpc/branches/fixes_2_6 |
| − | ~/fpc/ | + | ~/fpc/fpcsrc/compiler/utils/msg2inc.pp #contains FPC msg2inc tool |
| − | </ | + | </syntaxhighlight> |
| + | == Generating documentation == | ||
| + | |||
| + | make clean | ||
| + | sh fixdocs.sh | ||
| − | |||
write me ;) | write me ;) | ||
Latest revision as of 12:09, 10 November 2023
Overview
This tutorial will guide you through getting the latest FreePascal docs sources and generating documentation from it. Please see the official documentation [3] for more details.
November 2011: I'm having trouble generating docs, and finding documentation on it, so I decided to start this page to help me and others. Please feel free to update/add info (and remove this notice when it actually works ;) --BigChimp 05:11, 22 November 2011 (CET)
Prerequisites
- A working FreePascal environment must be installed (e.g. a stable version from a Debian repository). See [1] for more details.
- Having a working Lazarus installed may not hurt
- As the documentation needs FPC source files, you will need the latest source from git. See [1] on how to get that.
- The fpcdocs:
svn co http://svn.freepascal.org/svn/fpcdocs/trunk fpcdocs
- Some tex programs: texlive, tex4ht, and dvi2tty if you want to generate plain-text documents (for DOS, mainly). The package names may differ depending on your distribution. The files a4.sty and moveverb.sty.
- Ubuntu 12:
apt-get install tex4ht texlive-binaries texlive-latex-base texlive-latex-recommended texlive-latex-extra
- Ubuntu 12:
Assumptions
I'm assuming you're running on Linux; apparently generating docs on Windows is not supported. Also, this tutorial assumes you have a stable system-wide installation of FPC and Lazarus, and a working SVN version of FPC with proper fpc.cfg. Finally, you have your SVN FPC source and fpcdocs directories set up like this:
~/fpc/
~/fpc/fpcdocs #contains SVN http://svn.freepascal.org/svn/fpcdocs/trunk
~/fpc/fpcsrc #contains FPC sources, e.g. http://svn.freepascal.org/svn/fpc/branches/fixes_2_6
~/fpc/fpcsrc/compiler/utils/msg2inc.pp #contains FPC msg2inc tool
Generating documentation
make clean sh fixdocs.sh
write me ;)
References
- [1] Installing Lazarus
- [2] Build FAQ
- [3] FPDoc manual
