readme.txt

   1
   2 HipHop Compiler for PHP Usage:
   3
   4         hphp <options> <inputs>
   5
   6 Options:
   7   --help                           display this message
   8   -t [ --target ] arg (=run)       lint | analyze | php | cpp | filecache | run
   9                                    (default)
  10   -f [ --format ] arg              lint: (none);
  11                                    analyze: (none);
  12                                    php: trimmed (default) | inlined | pickled |
  13                                    typeinfo | <any combination of them by any
  14                                    separator>;
  15                                    cpp: cluster (default) | file | sys | exe |
  16                                    lib;
  17                                    run: cluster (default) | file
  18   --cluster-count arg (=0)         Cluster by file sizes and output roughly
  19                                    these many number of files. Use 0 for no
  20                                    clustering.
  21   --input-dir arg                  input directory
  22   --program arg (=program)         final program name to use
  23   --args arg                       program arguments
  24   -i [ --inputs ] arg              input file names
  25   --input-list arg                 file containing list of file names, one per
  26                                    line
  27   --include-path arg               a list of include paths to search for files
  28                                    being included in includes or requires but
  29                                    cannot be found assuming relative paths
  30   --module arg                     directories containing all input files
  31   --exclude-dir arg                directories to exclude from the input
  32   --fmodule arg                    same with module, except no exclusion
  33                                    checking is performed, so these modules are
  34                                    forced to be included
  35   --ffile arg                      extra PHP files forced to include without
  36                                    exclusion checking
  37   --exclude-file arg               files to exclude from the input, even if
  38                                    parse-on-demand finds it
  39   --exclude-pattern arg            regex (in 'find' command's regex command
  40                                    line option format)  of files or directories
  41                                    to exclude from the input, even if
  42                                    parse-on-demand finds it
  43   --exclude-static-pattern arg     regex (in 'find' command's regex command
  44                                    line option format)  of files or directories
  45                                    to exclude from static content cache it
  46   --cfile arg                      extra static files forced to include without
  47                                    exclusion checking
  48   --cmodule arg                    extra directories for static files without
  49                                    exclusion checking
  50   --parse-on-demand arg (=1)       whether to parse files that are not
  51                                    specified from command line
  52   --branch arg                     SVN branch
  53   --revision arg                   SVN revision
  54   -o [ --output-dir ] arg          output directory
  55   --sync-dir arg                   Files will be created in this directory
  56                                    first, then sync with output directory
  57                                    without overwriting identical files. Great
  58                                    for incremental compilation and build.
  59   --optimize-level arg (=1)        optimization level
  60   --gen-stats arg (=0)             whether to generate dependency graphs and
  61                                    code errors
  62   -k [ --keep-tempdir ] arg (=0)   whether to keep the temporary directory
  63   --static-method-autofix arg (=1) whether to change a method to static if it
  64                                    is called statically
  65   --db-stats arg                   database connection string to save
  66                                    dependency graphs and code errors:
  67                                    <username>:<password>@<host>:<port>/<db>
  68   --no-type-inference arg (=0)     turn off type inference for C++ code
  69                                    generation
  70   --no-min-include arg (=0)        turn off minimium include analysis when
  71                                    target is "analyze"
  72   --no-meta-info arg (=0)          do not generate class map, function jump
  73                                    table and macros when generating code; good
  74                                    for demo purposes
  75   --config arg                     config file name
  76   --db-config arg                  database connection string to read
  77                                    configurable options from:
  78                                    <username>:<password>@<host>:<port>/<db>
  79   --config-dir arg                 root directory configuration is based on
  80                                    (for example, excluded directories may be
  81                                    relative path in configuration.
  82   -v [ --config-value ] arg        individual configuration string in a format
  83                                    of name=value, where name can be any valid
  84                                    configuration for a config file
  85   --log arg (=-1)                  -1: (default); 0: no logging; 1: errors
  86                                    only; 2: warnings and errors; 3:
  87                                    informational as well; 4: really verbose.
  88   --force arg (=0)                 force to ignore code generation errors and
  89                                    continue compilations
  90   --file-cache arg                 if specified, generate a static file cache
  91                                    with this file name
  92   --rtti-directory arg             the directory of rtti profiling data
  93   --java-root arg (=php)           the root package of generated Java FFI
  94                                    classes
  95   --generate-ffi arg (=0)          generate ffi stubs
  96   --dump arg (=0)                  dump the program graph