source: Dev/trunk/src/client/util/build/help.txt

Last change on this file was 483, checked in by hendrikvanantwerpen, 11 years ago

Added Dojo 1.9.3 release.

File size: 4.6 KB
Line 
1NAME
2     The Dojo Builder - Read, process, and write a set of resources as instructed by a profile.
3
4DESCRIPTION
5     Discover and process a set of resources with an ordered synchronized set of transforms.
6
7     See http://dojotoolkit.org/reference-guide/build/index.html for reference documentation.
8     
9     See http://dojotoolkit.org/reference-guide/build/qref.html for a quick reference manual.
10
11     Typically this program is executed with the convience wrapper /util/buildscripts/build.bat (Window) or
12     /util/buildscripts/build.sh (all other environments); it may also be executed explicitly.
13
14     Usage with the build script on non-windows:
15     path/to/util/buildscripts/build.sh [options]
16     
17     Usage with the build script on windows:
18     IMPORTANT: the util/buildscripts directory must be the current working directory
19     build.bat [options]
20
21     Explicit usage with node.js:
22     node path/to/dojo/dojo.js load=build [options]
23     
24     Explicit usage with java:
25     java -Xms256m -Xmx256m -jar path/to/util/shrinksafe/js.jar path/to/dojo/dojo.js baseUrl=path/to/dojo load=build [options]
26     
27     IMPORTANT:
28     This program assumes the default directory structure provided with the standard dojo source release.
29     
30     IMPORTANT:
31     When using v1.6- profiles, this program assumes the current working directory is utils/buildscripts.
32
33OPTIONS
34     -p <filename>
35     --profile <filename>      read profile for file
36     
37     -p <profile>
38     --profile <profile>       read profile from profile in util/buildscripts/profiles
39     
40     --package <path>          read profile from package.json located in the directory path
41     
42     --require <filename>
43     --dojoConfig              read profile from loader configuration
44     
45     --htmlFiles <file-list>   deduce profile from HTML file(s); file-list is a comma-separated list of filenames
46     
47     --htmlDir <path>          deduce profile from all HTML files in directory at path
48     
49     --check-args              print computed raw command line input, including raw profiles, then terminate
50     
51     --check                   print computed profile, then terminate
52     
53     --check-discovery         print all discovered resources, then terminate
54     
55     --debug-check             print computed profile, including internal structures
56     
57     -r
58     --release                 process the build control script(s) and/or profile(s) and transform sources into a release
59     
60     --releaseDir <path>       base directory for build output
61     
62     --releaseName <string>    path segment to append to releaseDir that gives base directory for build output
63
64     --layerOptimize <arg>     process all layer resources in order to minimize resource size; arg as follows:
65                                   comments             => remove comments with ShrinkSafe
66                                   comments.keeplines   => as above, but don't remove newlines
67                                   shrinksafe           => minimize with ShrinkSafe
68                                   shrinksafe.keeplines => as above, but don't remove newlines
69                                   closure              => minimize with the Google Closure compiler
70                                   closure.keeplines    => as above, but don't remove newlines
71                                   uglify               => minimize with Uglify
72                                   uglify.keeplines     => as above, but don't remove newlines
73                               (note: all args are case-insensitive)
74
75     --optimize <arg>          analogous to --layerOptimize, but applied to non-layer resources
76
77     --useSourceMaps <arg>     create source maps when the Google Closure compiler is used; arg as follows:
78                                   true  => create source maps (default)
79                                   false => don't create source maps
80
81     --copyTests <arg>         copy test files and the DOH package; arg as follows:
82                                   false => don't copy tests
83                                   true  => copy test resources, but don't apply any transforms
84                                   build => copy and build tests resources just as if they were normal resources
85
86     --mini                    Ignore resources tagged as not mini (e.g. tests, demos dijit/bench, etc.)
87     
88     -v                        print the program's version number
89     
90     --help                    this help message
91     
92     Scalar profile property values may also be specified as options with the syntax
93     
94          --<profile-property-name> <value>
95     
Note: See TracBrowser for help on using the repository browser.