source: Dev/branches/rest-dojo-ui/client/util/build/help.txt @ 256

Last change on this file since 256 was 256, checked in by hendrikvanantwerpen, 13 years ago

Reworked project structure based on REST interaction and Dojo library. As
soon as this is stable, the old jQueryUI branch can be removed (it's
kept for reference).

File size: 3.1 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     --writeProfile <filename> write the processed profile to filename
65     
66     --copyTests               Copy test files and the DOH package.
67     
68     --mini                    Ignore resources tagged as not mini (e.g. tests, demos dijit/bench, etc.)
69     
70     -v                        print the program's version number
71     
72     --help                    this help message
73     
74     Scalar profile property values may also be specified as options with the syntax
75     
76          --<profile-property-name> <value>
77     
Note: See TracBrowser for help on using the repository browser.