Differences

This shows you the differences between two versions of the page.

--- doc:phd:view [2008/03/10 00:57] – imported, originally written by Hannes philip
+++ doc:phd:view [2017/09/22 13:28] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 ====== Viewing the results ======
-After [[doc:phd|building the docs]] you probably want to view them now.
+After [[doc:phd|building the docs]] it's time to view them. There are a few choices:
-You have a few choices:
-  * See how it would be online (the php/ folder)
+  * View how it would look online (the php/ folder, which uses the theme used by www.php.net)
-  * Just quickly see the results (the html/ folder)
+  * View the plain html (the html/ folder)
-  * Test how long it takes for your browser to render 20mb xhtml file (the bightml.html file)
+  * 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 www.php.net, so to view them you need a ''phpweb'' mirror.
+These files are tightly integrated into www.php.net, so to simplest way to view them is to
-This method is currently the only "supported" method as the online manual is the most important one. If you don't have the ''fetch'' command, try ''wget'' or ''curl -O'' instead.
+setup a ''phpweb'' mirror.
-(Note; On Windows you are pretty much out of luck regarding instructions on setting up a ''phpweb'' mirror, you may try the following instructions but I have no idea if it would work.)
+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):
 <code bash>
-$ cd /path/to/your/web/root
+$ rsync -avzC --timeout=600 --delete --delete-after \
-$ cvs -d:pserver:cvsread@cvs.php.net/repository co phpweb && cd phpweb
+    --exclude='manual/**' --exclude='distributions/**' --exclude='extra/**' --exclude='backend/notes/**' \
-$ (cd include && for i in countries.inc last_updated.inc mirrors.inc pregen-confs.inc pregen-events.inc pregen-news.inc; do fetch "http://www.php.net/include/$i"; done;)
+    rsync.php.net::phpweb /path/to/your/webroot/phpweb
-$ (cd backend && for i in ip-to-country.db ip-to-country.idx; do fetch "http://www.php.net/backend/$i"; done;)
+$ ln -s /path/to/phd/php /path/to/your/webroot/phpweb/manual/en
-$ (cd manual && ln -s /path/to/phd/php en)
 </code>
-(Yes. The parentheses **//are//** important!)
-Now locate your webserver configuration file and add a new virtual host.
+Notes:
-For an example virtual host configuration, see [[http://www.php.net/mirroring.php#settings]].
+  * Change /path/to/your/webroot/phpweb
-Now restart your webserver. Tada!
+  * 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: [[http://www.php.net/mirroring.php#settings]].
+  * 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 faviorite file manager and open the "index.html" file (or any page you are interested in viewing).
+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 =====
-Double click it.
+Is that really wise?

Differences

Page Tools