File: command.html

package info (click to toggle)
pubtal 3.5-1
  • links: PTS, VCS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, stretch, wheezy
  • size: 1,296 kB
  • ctags: 910
  • sloc: python: 8,027; xml: 150; makefile: 49
file content (62 lines) | stat: -rw-r--r-- 4,483 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
	<title>Commands Reference</title>
	<link href="../style/site.css" type="text/css" rel="stylesheet">
</head>
<body>
<h1>Commands Reference</h1>
  <p id="subject">PubTal Commands Reference.</p>
  <div><p>PubTal supplies two commands: updateSite.py and uploadSite.py.&nbsp; These are used to rebuild a website and upload a website respectively.</p>
<h2>updateSite.py</h2>
<p>This takes a minimum of one parameter, the location of the website configuration file.</p>
<pre>updateSite.py [options] site.config [content-dir | content-file] [...]</pre>
<p>The updateSite.py command first reads in the configuration file and so locates the content, template, and destination directories (defaulting to content, template, and dest respectively).&nbsp; If only one parameter is passed to updateSite.py, it will then find each file under the content directory and build the corresponding output files.</p>
<p>If more than one parameter is passed, then each extra parameter is taken as content to build.&nbsp; If the parameter is a directory under the content directory, then any content files in that directory will be built recursively.&nbsp; If the parameter is a file in the content directory (or one of its children), then just that file will be built.</p>
<p>Take for example:</p>
<pre>updateSite.py new-site/site.config new-site/content/index.txt new-site/content/examples/</pre>
<p>This will build the index.txt file into index.html and all content files under content/examples/ will be built into their corresponding output files.</p>
<h3>options</h3>
<p>The following options are supported:</p>
<ul>
	<li>-h | --help - Prints out the help description for the command.</li>
	<li>-a | --all - Builds all classes of content, not just content in the "normal" class.</li>
	<li>--class classParams - Builds all classes given as supplied in a comma separated list.</li>
	<li>--logging - Turns on logging.</li>
	<li>--logfile name - Logs to the file "name" (defaults to updateSite.log).</li>
	<li>--debug - Turns on debug logging; implies --logging.</li>
	<li>--debug-simpletal - Turns on debug logging of SimpleTAL, implies --logging.</li>
</ul>
<h2>uploadSite.py</h2>
<p>This takes a minimum of one parameter, the location of the website configuration file.</p>
<pre>uploadSite.py [options] site.config [destination-dir | destination-file] [...]</pre>
<p>The uploadSite.py command first reads in the configuration file and so locates the destination directories.&nbsp; If only one parameter is passed to uploadSite.py, it will then find each file under the destination directory that needs to be uploaded.&nbsp; The logic used to determine whether a file needs to be uploaded is explained in the <a href="uploading.html">Uploading section</a>.</p>
<p>If more than one parameter is passed, then each extra parameter is taken as destination to upload.&nbsp; If the parameter is a directory under the destination directory then any files in that directory will be considered for upload recursively.&nbsp; If the parameter is a file in the destination directory (or one of its children), then just that file will be considered for upload.</p>
<p>Take for example:</p>
<pre>uploadSite.py new-site/site.config new-site/dest/index.html new-site/dest/examples/</pre>
<p>This will examine the index.html file and all files under dest/examples/ when determining what files to upload.</p>
<h3>options</h3>
<p>The following options are supported:</p>
<ul>
	<li>-h | --help - Prints out the help description for the command.</li>
	<li>-a | --all - Checks all files are uploaded, not just PubTal generated ones.</li>
	<li>--force - Uploads files even if PubTal thinks they are up-to-date.</li>
	<li>--dry-run - Prints out what would have been done, but takes no action.</li>
	<li>--logging - Turns on logging.</li>
	<li>--logfile name - Logs to the file "name" (defaults to updateSite.log).</li>
	<li>--debug - Turns on debug logging; implies --logging.</li>
</ul>
</div>
	  
	
  <div class="navbar">
  <a href="index.html" title="Contents">Contents</a>
  </div>
  <p id="version">PubTal Version 3.5</p>
  <div id="footer">
  <p>File: command.txt</p>
  <p>Last modified: Fri, 27 Jul 2007 18:34:31 BST</p>
  <p>Copyright 2011 Colin Stewart</p>
  <p title="PubTal is a template driven web site publisher.">Made with <a href="http://www.owlfish.com/software/PubTal/">PubTal</a> 3.5</p>
  </div>
</body>