SliTaz Repositories

     1.1 --- a/doc/cookutils.en.html	Fri May 06 04:07:11 2011 +0200
     1.2 +++ b/doc/cookutils.en.html	Fri May 06 04:46:36 2011 +0200
     1.3 @@ -29,16 +29,32 @@
     1.4  	who let you view cook logs in a nice and colored way.
     1.5  </p>
     1.6  
     1.7 +<h3>Cook usage</h3>
     1.8 +<p>
     1.9 +	Cook provide a small built-in help usage that you can display with
    1.10 +	the command:
    1.11 +</p>
    1.12 +<pre>
    1.13 +# cook usage
    1.14 +</pre>
    1.15 +
    1.16  <h3>Howto work</h3>
    1.17  <p>
    1.18  	The first thing you will have to do before building packages is to setup
    1.19  	your environment. These 2 recommended way to work: cook directly on host
    1.20  	or cook in chroot to protect your host. In the case you want to work in a
    1.21 -	chroot you can use Tazdev to create one and chroot in it: 
    1.22 +	chroot you can install and use Tazdev to create one and chroot in it: 
    1.23  </p>
    1.24  <pre>
    1.25  # tazdev gen-chroot &amp;&amp; tazdev chroot
    1.26  </pre>
    1.27 +<p>
    1.28 +	By default Tazdev create a chrrot in /home/slitaz/cooking/chroot but you
    1.29 +	can specify a custome path in argument. The chroot place is not important,
    1.30 +	when you will be in the chroot you will use standard SliTaz path such as
    1.31 +	/home/slitaz/wok for the wok directory or /home/slitaz/log for all the cook
    1.32 +	logs. As usual you can diplay tazdev help usage with: tazdev usage
    1.33 +</p>
    1.34  
    1.35  <h3>Getting started</h3>
    1.36  <p>
    1.37 @@ -52,6 +68,15 @@
    1.38  <pre>
    1.39  # cook setup
    1.40  </pre>
    1.41 +<p>
    1.42 +	The setup command have a --wok option who let you clone SliTaz wok while
    1.43 +	setting up your cook environment. Even if you not yet an official developers
    1.44 +	you can	clone it and use existing packages as example to create your own.
    1.45 +	To setup and clone the wok:
    1.46 +</p>
    1.47 +<pre>
    1.48 +# cook setup --wok
    1.49 +</pre>
    1.50  
    1.51  <h3>Test your environment</h3>
    1.52  <p>
    1.53 @@ -134,6 +159,13 @@
    1.54  	default on any SliTaz system since we provide CGI support via Busybox httpd
    1.55  	web server.
    1.56  </p>
    1.57 +<p>
    1.58 +	The Cooker provide a small built-in help usage that you can display with
    1.59 +	the command:
    1.60 +</p>
    1.61 +<pre>
    1.62 +# cooker --usage
    1.63 +</pre>
    1.64  
    1.65  <h3>Cooker setup</h3>
    1.66  <p>
    1.67 @@ -186,10 +218,10 @@
    1.68  <h3>Cooker CGI/Web</h3>
    1.69  <p>
    1.70  	To let you view log files in a nice way, keep activity trace and help find
    1.71 -	errors, you can use the Cooker Web interface located by default in
    1.72 -	/var/www/cooker. If you dont use a chroot and the Busybox httpd web server
    1.73 -	is running, the web interface will work without modifiaction and should be
    1.74 -	reachable at: <a href="http://localhost/cgi-bin/cooker/cooker.cgi">
    1.75 +	errors, you can use the Cooker Web interface located by default in the folder
    1.76 +	/var/www/cgi-bin/cooker. If you dont use a chroot and the Busybox httpd
    1.77 +	web server is running, the web interface will work without configuration and
    1.78 +	should be reachable at: <a href="http://localhost/cgi-bin/cooker/cooker.cgi">
    1.79  		http://localhost/cgi-bin/cooker/cooker.cgi</a> 
    1.80  </p>
    1.81  <p>
    1.82 @@ -201,7 +233,7 @@
    1.83  /home/slitaz/cooking/chroot
    1.84  </pre>
    1.85  <p>
    1.86 -With /etc/slitaz/cook.conf modified as bellow:
    1.87 +	With /etc/slitaz/cook.conf modified as bellow:
    1.88  </p>
    1.89  <pre>
    1.90  SLITAZ="/home/slitaz/cooking/chroot/home/slitaz"
    1.91 @@ -209,15 +241,17 @@
    1.92  <p>
    1.93  	Note: It's not obligatory to install the cookutils on your host to use the
    1.94  	web interface, you can also copy the cooker.cgi and style.css files for
    1.95 -	example in your ~/Public directory and use a custom cook.conf with it. Say
    1.96 -	you have cloned or downloaded the cookutils:
    1.97 +	example in your ~/Public directory and use a custom cook.conf with it. The
    1.98 +	advantage of installing cookutils on the host is to get regular update via
    1.99 +	Tazpkg packages manager. Say you have cloned or downloaded the cookutils:
   1.100  </p>
   1.101  <pre>
   1.102 -$ cp cookutils/web ~/Public/cgi-bin/cooker
   1.103 -$ cp cookutils/cook.conf ~/Public/cgi-bin/cooker
   1.104 +$ cp -a cookutils/web ~/Public/cgi-bin/cooker
   1.105 +$ cp -f cookutils/cook.conf ~/Public/cgi-bin/cooker
   1.106  </pre>
   1.107  <p>
   1.108 -Edit ~/Public/cgi-bin/cooker/cook.conf and you all done!
   1.109 +	Edit the configuration file: ~/Public/cgi-bin/cooker/cook.conf to set
   1.110 +	SLITAZ path and you all done!
   1.111  </p>
   1.112  
   1.113  <h3>Cooknotes</h3>