# HG changeset patch # User David Demelier # Date 1455020062 -3600 # Node ID 59c152b4508da336f85bb16d28a9c44883d2e89f # Parent 9a117bb9021431b2a7c56046907c7939872b3630 Docs: remove shell information, reorder options diff -r 9a117bb90214 -r 59c152b4508d doc/html/guide/02-install/01-building-from-sources.md --- a/doc/html/guide/02-install/01-building-from-sources.md Tue Feb 09 13:01:03 2016 +0100 +++ b/doc/html/guide/02-install/01-building-from-sources.md Tue Feb 09 13:14:22 2016 +0100 @@ -24,11 +24,11 @@ then type the following commands: ```` -markand@localhost [irccd-2.0.0] $ mkdir _build_ -markand@localhost [irccd-2.0.0] $ cd _build_ -markand@localhost [irccd-2.0.0/_build_] $ cmake .. -markand@localhost [irccd-2.0.0/_build_] $ make -markand@localhost [irccd-2.0.0/_build_] $ sudo make install +$ mkdir _build_ +$ cd _build_ +$ cmake .. +$ make +$ sudo make install ```` This is the quick way of compiling and installing. It's also possible to set some options to customize the build. diff -r 9a117bb90214 -r 59c152b4508d doc/html/guide/02-install/02-customize.md --- a/doc/html/guide/02-install/02-customize.md Tue Feb 09 13:01:03 2016 +0100 +++ b/doc/html/guide/02-install/02-customize.md Tue Feb 09 13:14:22 2016 +0100 @@ -7,25 +7,7 @@ You can disable JavaScript support. ```` -markand@localhost [irccd-2.0.0/_build_] $ cmake .. -DWITH_JS=Off -```` - -### Disabling all documentation - -You can disable all the documentation. - -```` -markand@localhost [irccd-2.0.0/_build_] $ cmake .. -DWITH_DOCS=Off -```` - -See below to disable only specific parts of the documentation. - -### Disabling HTML documentation - -By default if Pandoc is available, the HTML documentation is built, you can disable it. - -```` -markand@localhost [irccd-2.0.0/_build_] $ cmake .. -DWITH_HTML=Off +$ cmake .. -DWITH_JS=Off ```` ### Disabling SSL @@ -37,7 +19,25 @@ ```` -markand@localhost [irccd-2.0.0/_build_] $ cmake .. -DWITH_SSL=Off +$ cmake .. -DWITH_SSL=Off +```` + +### Disabling all documentation + +You can disable all the documentation. + +```` +$ cmake .. -DWITH_DOCS=Off +```` + +See below to disable only specific parts of the documentation. + +### Disabling HTML documentation + +By default if Pandoc is available, the HTML documentation is built, you can disable it. + +```` +$ cmake .. -DWITH_HTML=Off ```` ### Disabling man pages @@ -45,7 +45,7 @@ You can disable installation of manuals. ```` -markand@localhost [irccd-2.0.0/_build_] $ cmake .. -DWITH_MAN=Off +$ cmake .. -DWITH_MAN=Off ```` ### Installation path @@ -58,7 +58,7 @@ To change this, use the following: ```` -markand@localhost [irccd-2.0.0/_build_] $ cmake .. -DCMAKE_INSTALL_PREFIX=/opt/some/directory +$ cmake .. -DCMAKE_INSTALL_PREFIX=/opt/some/directory ```` ### Manual pages path @@ -68,5 +68,5 @@ For example, on FreeBSD the typical use would be: ```` -markand@localhost [irccd-2.0.0/_build_] $ cmake .. -DWITH_MANDIR=/usr/local/man +$ cmake .. -DWITH_MANDIR=/usr/local/man ````