Viewing the results

After building the docs it's time to view them. There are a few choices:

  • View how it would look online (the php/ folder, which uses the theme used by
  • View the plain html (the html/ folder)
  • View the single file plain html, which is around 20mb (the bightml.html file)
  • And other formats that require additional setup to the build environment: chm, pdf and *nix man pages

Viewing the php/ folder

These files are tightly integrated into, so to simplest way to view them is to setup a phpweb mirror.

Note: These instructions likely don't work on Windows, but may, feel free to update them to do so (rsync alternative?)

So, the mirrors use the rsync command. The following will work and it disables downloading parts of the mirror (like all the distributed php source files):

$ rsync -avzC --timeout=600 --delete --delete-after \
    --exclude='manual/**' --exclude='distributions/**' --exclude='extra/**' --exclude='backend/notes/**' \ /path/to/your/webroot/phpweb
$ ln -s /path/to/phd/php /path/to/your/webroot/phpweb/manual/en


  • Change /path/to/your/webroot/phpweb
  • The 'ln -s' creates a symlink from your build directory to this location in the docroot
  • The docroot will likely be setup as a new virtual host via the web server configuration file
  • See also an example virtual host configuration here:
  • Once the changes are made, restart the web server.

Viewing the html/ folder

Do not place the contents of the html/ folder onto your webserver. Especially not if you are running apache2. Just browse to the folder in your favorite file manager and open the “index.html” file (or any page you are interested in viewing).

Viewing the bightml.html file

Is that really wise?

doc/phd/view.txt · Last modified: 2017/09/22 13:28 by