Advertisement
leneshka

Composer description xml for PhpStorm

Oct 24th, 2012
1,491
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
XML 37.10 KB | None | 0 0
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <framework xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.           xsi:noNamespaceSchemaLocation="schemas/frameworkDescriptionVersion1.1.2.xsd" name="composer"
  4.           invoke="$PhpExecutable$ composer.phar" alias="composer" enabled="true" version="2">
  5.     <command>
  6.         <name>about</name>
  7.         <help><![CDATA[<h2>about</h2>
  8. <p>Usage:<br>
  9. about
  10. </p>
  11. <p>Short information about Composer
  12. </p>
  13. <table>
  14.    <tr><td><strong>Options:</strong></td></tr>
  15. <tr>
  16.        <td>--help (-h)</td>
  17.        <td>Display this help message.</td>
  18.    </tr>
  19. <tr>
  20.        <td>--quiet (-q)</td>
  21.        <td>Do not output any message.</td>
  22.    </tr>
  23. <tr>
  24.        <td>--verbose (-v)</td>
  25.        <td>Increase verbosity of messages.</td>
  26.    </tr>
  27. <tr>
  28.        <td>--version (-V)</td>
  29.        <td>Display this application version.</td>
  30.    </tr>
  31. <tr>
  32.        <td>--ansi</td>
  33.        <td>Force ANSI output.</td>
  34.    </tr>
  35. <tr>
  36.        <td>--no-ansi</td>
  37.        <td>Disable ANSI output.</td>
  38.    </tr>
  39. <tr>
  40.        <td>--no-interaction (-n)</td>
  41.        <td>Do not ask any interactive question.</td>
  42.    </tr>
  43. <tr>
  44.        <td>--profile</td>
  45.        <td>Display timing and memory usage information</td>
  46.    </tr>
  47. <tr>
  48.        <td>--working-dir (-d)</td>
  49.        <td>If specified, use the given directory as working directory.</td>
  50.    </tr>
  51. </table>
  52. <br>
  53. <p>Help:<br/>
  54. <info>php composer.phar about</info></p>
  55. ]]></help>
  56.     </command>
  57.     <command>
  58.         <name>config</name>
  59.         <params>setting-key[=null] setting-value[=null] </params>
  60.         <help><![CDATA[<h2>config</h2>
  61. <p>Usage:<br>
  62. config [-g|--global] [-e|--editor] [--unset] [-l|--list] [-f|--file="..."] [setting-key] [setting-value1] ... [setting-valueN]
  63. </p>
  64. <p>Set config options
  65. </p>
  66. <table>
  67.    <tr><td><strong>Arguments:</strong></td></tr>
  68.        <params><tr>
  69.        <td>setting-key</td>
  70.        <td>Setting key</td>
  71.    </tr>
  72. <tr>
  73.        <td>setting-value</td>
  74.        <td>Setting value</td>
  75.    </tr>
  76. </table>
  77. <br>
  78. <table>
  79.    <tr><td><strong>Options:</strong></td></tr>
  80. <tr>
  81.        <td>--global (-g)</td>
  82.        <td>Apply command to the global config file</td>
  83.    </tr>
  84. <tr>
  85.        <td>--editor (-e)</td>
  86.        <td>Open editor</td>
  87.    </tr>
  88. <tr>
  89.        <td>--unset</td>
  90.        <td>Unset the given setting-key</td>
  91.    </tr>
  92. <tr>
  93.        <td>--list (-l)</td>
  94.        <td>List configuration settings</td>
  95.    </tr>
  96. <tr>
  97.        <td>--file (-f)</td>
  98.        <td>If you want to choose a different composer.json or config.json</td>
  99.    </tr>
  100. <tr>
  101.        <td>--help (-h)</td>
  102.        <td>Display this help message.</td>
  103.    </tr>
  104. <tr>
  105.        <td>--quiet (-q)</td>
  106.        <td>Do not output any message.</td>
  107.    </tr>
  108. <tr>
  109.        <td>--verbose (-v)</td>
  110.        <td>Increase verbosity of messages.</td>
  111.    </tr>
  112. <tr>
  113.        <td>--version (-V)</td>
  114.        <td>Display this application version.</td>
  115.    </tr>
  116. <tr>
  117.        <td>--ansi</td>
  118.        <td>Force ANSI output.</td>
  119.    </tr>
  120. <tr>
  121.        <td>--no-ansi</td>
  122.        <td>Disable ANSI output.</td>
  123.    </tr>
  124. <tr>
  125.        <td>--no-interaction (-n)</td>
  126.        <td>Do not ask any interactive question.</td>
  127.    </tr>
  128. <tr>
  129.        <td>--profile</td>
  130.        <td>Display timing and memory usage information</td>
  131.    </tr>
  132. <tr>
  133.        <td>--working-dir (-d)</td>
  134.        <td>If specified, use the given directory as working directory.</td>
  135.    </tr>
  136. </table>
  137. <br>
  138. <p>Help:<br/>
  139. This command allows you to edit some basic composer settings in either the
  140.        local composer.json file or the global config.json file.
  141. <br>        To edit the global config.json file:
  142. <br>        <comment>composer.phar config --global</comment>
  143. <br>        To add a repository:
  144. <br>        <comment>composer.phar config repositories.foo vcs http://bar.com</comment>
  145. <br>        You can add a repository to the global config.json file by passing in the
  146.        <info>--global</info> option.
  147. <br>        To edit the file in an external editor:
  148. <br>        <comment>composer.phar config --edit</comment>
  149. <br>        To choose your editor you can set the "EDITOR" env variable.
  150. <br>        To get a list of configuration values in the file:
  151. <br>        <comment>composer.phar config --list</comment>
  152. <br>        You can always pass more than one option. As an example, if you want to edit the
  153.        global config.json file.
  154. <br>        <comment>composer.phar config --edit --global</comment></p>
  155. ]]></help>
  156.     </command>
  157.     <command>
  158.         <name>create-project</name>
  159.         <params>package directory[=null] version[=null] </params>
  160.         <help><![CDATA[<h2>create-project</h2>
  161. <p>Usage:<br>
  162. create-project [--prefer-source] [--prefer-dist] [--repository-url="..."] [--dev] [--no-custom-installers] [--no-scripts] [--keep-vcs] package [directory] [version]
  163. </p>
  164. <p>Create new project from a package into given directory.
  165. </p>
  166. <table>
  167.    <tr><td><strong>Arguments:</strong></td></tr>
  168.        <params><tr>
  169.        <td>package</td>
  170.        <td>Package name to be installed</td>
  171.    </tr>
  172. <tr>
  173.        <td>directory</td>
  174.        <td>Directory where the files should be created</td>
  175.    </tr>
  176. <tr>
  177.        <td>version</td>
  178.        <td>Version, will defaults to latest</td>
  179.    </tr>
  180. </table>
  181. <br>
  182. <table>
  183.    <tr><td><strong>Options:</strong></td></tr>
  184. <tr>
  185.        <td>--prefer-source</td>
  186.        <td>Forces installation from package sources when possible, including VCS information.</td>
  187.    </tr>
  188. <tr>
  189.        <td>--prefer-dist</td>
  190.        <td>Forces installation from package dist even for dev versions.</td>
  191.    </tr>
  192. <tr>
  193.        <td>--repository-url</td>
  194.        <td>Pick a different repository url to look for the package.</td>
  195.    </tr>
  196. <tr>
  197.        <td>--dev</td>
  198.        <td>Whether to install dependencies for development.</td>
  199.    </tr>
  200. <tr>
  201.        <td>--no-custom-installers</td>
  202.        <td>Whether to disable custom installers.</td>
  203.    </tr>
  204. <tr>
  205.        <td>--no-scripts</td>
  206.        <td>Whether to prevent execution of all defined scripts in the root package.</td>
  207.    </tr>
  208. <tr>
  209.        <td>--keep-vcs</td>
  210.        <td>Whether to prevent deletion vcs folder.</td>
  211.    </tr>
  212. <tr>
  213.        <td>--help (-h)</td>
  214.        <td>Display this help message.</td>
  215.    </tr>
  216. <tr>
  217.        <td>--quiet (-q)</td>
  218.        <td>Do not output any message.</td>
  219.    </tr>
  220. <tr>
  221.        <td>--verbose (-v)</td>
  222.        <td>Increase verbosity of messages.</td>
  223.    </tr>
  224. <tr>
  225.        <td>--version (-V)</td>
  226.        <td>Display this application version.</td>
  227.    </tr>
  228. <tr>
  229.        <td>--ansi</td>
  230.        <td>Force ANSI output.</td>
  231.    </tr>
  232. <tr>
  233.        <td>--no-ansi</td>
  234.        <td>Disable ANSI output.</td>
  235.    </tr>
  236. <tr>
  237.        <td>--no-interaction (-n)</td>
  238.        <td>Do not ask any interactive question.</td>
  239.    </tr>
  240. <tr>
  241.        <td>--profile</td>
  242.        <td>Display timing and memory usage information</td>
  243.    </tr>
  244. <tr>
  245.        <td>--working-dir (-d)</td>
  246.        <td>If specified, use the given directory as working directory.</td>
  247.    </tr>
  248. </table>
  249. <br>
  250. <p>Help:<br/>
  251. The <info>create-project</info> command creates a new project from a given
  252.        package into a new directory. You can use this command to bootstrap new
  253.        projects or setup a clean version-controlled installation
  254.        for developers of your project.
  255. <br>        <info>php composer.phar create-project vendor/project target-directory [version]</info>
  256. <br>        To setup a developer workable version you should create the project using the source
  257.        controlled code by appending the <info>'--prefer-source'</info> flag. Also, it is
  258.        advisable to install all dependencies required for development by appending the
  259.        <info>'--dev'</info> flag.
  260. <br>        To install a package from another repository than the default one you
  261.        can pass the <info>'--repository-url=http://myrepository.org'</info> flag.
  262.    </p>
  263. ]]></help>
  264.     </command>
  265.     <command>
  266.         <name>depends</name>
  267.         <params>package </params>
  268.         <help><![CDATA[<h2>depends</h2>
  269. <p>Usage:<br>
  270. depends [--link-type="..."] package
  271. </p>
  272. <p>Shows which packages depend on the given package
  273. </p>
  274. <table>
  275.    <tr><td><strong>Arguments:</strong></td></tr>
  276.        <params><tr>
  277.        <td>package</td>
  278.        <td>Package to inspect</td>
  279.    </tr>
  280. </table>
  281. <br>
  282. <table>
  283.    <tr><td><strong>Options:</strong></td></tr>
  284. <tr>
  285.        <td>--link-type</td>
  286.        <td>Link types to show (require, require-dev)</td>
  287.    </tr>
  288. <tr>
  289.        <td>--help (-h)</td>
  290.        <td>Display this help message.</td>
  291.    </tr>
  292. <tr>
  293.        <td>--quiet (-q)</td>
  294.        <td>Do not output any message.</td>
  295.    </tr>
  296. <tr>
  297.        <td>--verbose (-v)</td>
  298.        <td>Increase verbosity of messages.</td>
  299.    </tr>
  300. <tr>
  301.        <td>--version (-V)</td>
  302.        <td>Display this application version.</td>
  303.    </tr>
  304. <tr>
  305.        <td>--ansi</td>
  306.        <td>Force ANSI output.</td>
  307.    </tr>
  308. <tr>
  309.        <td>--no-ansi</td>
  310.        <td>Disable ANSI output.</td>
  311.    </tr>
  312. <tr>
  313.        <td>--no-interaction (-n)</td>
  314.        <td>Do not ask any interactive question.</td>
  315.    </tr>
  316. <tr>
  317.        <td>--profile</td>
  318.        <td>Display timing and memory usage information</td>
  319.    </tr>
  320. <tr>
  321.        <td>--working-dir (-d)</td>
  322.        <td>If specified, use the given directory as working directory.</td>
  323.    </tr>
  324. </table>
  325. <br>
  326. <p>Help:<br/>
  327. Displays detailed information about where a package is referenced.
  328. <br>        <info>php composer.phar depends composer/composer</info>
  329.    </p>
  330. ]]></help>
  331.     </command>
  332.     <command>
  333.         <name>dump-autoload</name>
  334.         <help><![CDATA[<h2>dump-autoload</h2>
  335. <p>Usage:<br>
  336. dump-autoload [-o|--optimize]
  337. </p>
  338. <p>dumps the autoloader
  339. </p>
  340. <table>
  341.    <tr><td><strong>Options:</strong></td></tr>
  342. <tr>
  343.        <td>--optimize (-o)</td>
  344.        <td>Optimizes PSR0 packages to be loaded with classmaps too, good for production.</td>
  345.    </tr>
  346. <tr>
  347.        <td>--help (-h)</td>
  348.        <td>Display this help message.</td>
  349.    </tr>
  350. <tr>
  351.        <td>--quiet (-q)</td>
  352.        <td>Do not output any message.</td>
  353.    </tr>
  354. <tr>
  355.        <td>--verbose (-v)</td>
  356.        <td>Increase verbosity of messages.</td>
  357.    </tr>
  358. <tr>
  359.        <td>--version (-V)</td>
  360.        <td>Display this application version.</td>
  361.    </tr>
  362. <tr>
  363.        <td>--ansi</td>
  364.        <td>Force ANSI output.</td>
  365.    </tr>
  366. <tr>
  367.        <td>--no-ansi</td>
  368.        <td>Disable ANSI output.</td>
  369.    </tr>
  370. <tr>
  371.        <td>--no-interaction (-n)</td>
  372.        <td>Do not ask any interactive question.</td>
  373.    </tr>
  374. <tr>
  375.        <td>--profile</td>
  376.        <td>Display timing and memory usage information</td>
  377.    </tr>
  378. <tr>
  379.        <td>--working-dir (-d)</td>
  380.        <td>If specified, use the given directory as working directory.</td>
  381.    </tr>
  382. </table>
  383. <br>
  384. <p>Help:<br/>
  385. <info>php composer.phar dump-autoload</info></p>
  386. ]]></help>
  387.     </command>
  388.     <command>
  389.         <name>dumpautoload</name>
  390.         <help><![CDATA[<h2>dumpautoload</h2>
  391. <p>Usage:<br>
  392. dumpautoload [-o|--optimize]
  393. </p>
  394. <p>dumps the autoloader
  395. </p>
  396. <table>
  397.    <tr><td><strong>Options:</strong></td></tr>
  398. <tr>
  399.        <td>--optimize (-o)</td>
  400.        <td>Optimizes PSR0 packages to be loaded with classmaps too, good for production.</td>
  401.    </tr>
  402. <tr>
  403.        <td>--help (-h)</td>
  404.        <td>Display this help message.</td>
  405.    </tr>
  406. <tr>
  407.        <td>--quiet (-q)</td>
  408.        <td>Do not output any message.</td>
  409.    </tr>
  410. <tr>
  411.        <td>--verbose (-v)</td>
  412.        <td>Increase verbosity of messages.</td>
  413.    </tr>
  414. <tr>
  415.        <td>--version (-V)</td>
  416.        <td>Display this application version.</td>
  417.    </tr>
  418. <tr>
  419.        <td>--ansi</td>
  420.        <td>Force ANSI output.</td>
  421.    </tr>
  422. <tr>
  423.        <td>--no-ansi</td>
  424.        <td>Disable ANSI output.</td>
  425.    </tr>
  426. <tr>
  427.        <td>--no-interaction (-n)</td>
  428.        <td>Do not ask any interactive question.</td>
  429.    </tr>
  430. <tr>
  431.        <td>--profile</td>
  432.        <td>Display timing and memory usage information</td>
  433.    </tr>
  434. <tr>
  435.        <td>--working-dir (-d)</td>
  436.        <td>If specified, use the given directory as working directory.</td>
  437.    </tr>
  438. </table>
  439. <br>
  440. <p>Help:<br/>
  441. <info>php composer.phar dump-autoload</info></p>
  442. ]]></help>
  443.     </command>
  444.     <command>
  445.         <name>help</name>
  446.         <params>command command_name[=null] </params>
  447.         <help><![CDATA[<h2>help</h2>
  448. <p>Usage:<br>
  449. help [--xml] [command_name]
  450. </p>
  451. <p>Displays help for a command
  452. </p>
  453. <table>
  454.    <tr><td><strong>Arguments:</strong></td></tr>
  455.        <params><tr>
  456.        <td>command</td>
  457.        <td>The command to execute</td>
  458.    </tr>
  459. <tr>
  460.        <td>command_name</td>
  461.        <td>The command name</td>
  462.    </tr>
  463. </table>
  464. <br>
  465. <table>
  466.    <tr><td><strong>Options:</strong></td></tr>
  467. <tr>
  468.        <td>--xml</td>
  469.        <td>To output help as XML</td>
  470.    </tr>
  471. <tr>
  472.        <td>--help (-h)</td>
  473.        <td>Display this help message.</td>
  474.    </tr>
  475. <tr>
  476.        <td>--quiet (-q)</td>
  477.        <td>Do not output any message.</td>
  478.    </tr>
  479. <tr>
  480.        <td>--verbose (-v)</td>
  481.        <td>Increase verbosity of messages.</td>
  482.    </tr>
  483. <tr>
  484.        <td>--version (-V)</td>
  485.        <td>Display this application version.</td>
  486.    </tr>
  487. <tr>
  488.        <td>--ansi</td>
  489.        <td>Force ANSI output.</td>
  490.    </tr>
  491. <tr>
  492.        <td>--no-ansi</td>
  493.        <td>Disable ANSI output.</td>
  494.    </tr>
  495. <tr>
  496.        <td>--no-interaction (-n)</td>
  497.        <td>Do not ask any interactive question.</td>
  498.    </tr>
  499. <tr>
  500.        <td>--profile</td>
  501.        <td>Display timing and memory usage information</td>
  502.    </tr>
  503. <tr>
  504.        <td>--working-dir (-d)</td>
  505.        <td>If specified, use the given directory as working directory.</td>
  506.    </tr>
  507. </table>
  508. <br>
  509. <p>Help:<br/>
  510. The <info>help</info> command displays help for a given command:
  511. <br>        <info>php composer.phar help list</info>
  512. <br>        You can also output the help as XML by using the <comment>--xml</comment> option:
  513. <br>        <info>php composer.phar help --xml list</info>
  514. <br>        To display the list of available commands, please use the <info>list</info> command.</p>
  515. ]]></help>
  516.     </command>
  517.     <command>
  518.         <name>init</name>
  519.         <help><![CDATA[<h2>init</h2>
  520. <p>Usage:<br>
  521. init [--name="..."] [--description="..."] [--author="..."] [--homepage="..."] [--require="..."] [--require-dev="..."] [--minimum-stability="..."]
  522. </p>
  523. <p>Creates a basic composer.json file in current directory.
  524. </p>
  525. <table>
  526.    <tr><td><strong>Options:</strong></td></tr>
  527. <tr>
  528.        <td>--name</td>
  529.        <td>Name of the package</td>
  530.    </tr>
  531. <tr>
  532.        <td>--description</td>
  533.        <td>Description of package</td>
  534.    </tr>
  535. <tr>
  536.        <td>--author</td>
  537.        <td>Author name of package</td>
  538.    </tr>
  539. <tr>
  540.        <td>--homepage</td>
  541.        <td>Homepage of package</td>
  542.    </tr>
  543. <tr>
  544.        <td>--require</td>
  545.        <td>Package to require with a version constraint, e.g. foo/bar:1.0.0 or foo/bar=1.0.0 or "foo/bar 1.0.0"</td>
  546.    </tr>
  547. <tr>
  548.        <td>--require-dev</td>
  549.        <td>Package to require for development with a version constraint, e.g. foo/bar:1.0.0 or foo/bar=1.0.0 or "foo/bar 1.0.0"</td>
  550.    </tr>
  551. <tr>
  552.        <td>--minimum-stability</td>
  553.        <td>Minimum stability (empty or one of: stable, RC, beta, alpha, dev)</td>
  554.    </tr>
  555. <tr>
  556.        <td>--help (-h)</td>
  557.        <td>Display this help message.</td>
  558.    </tr>
  559. <tr>
  560.        <td>--quiet (-q)</td>
  561.        <td>Do not output any message.</td>
  562.    </tr>
  563. <tr>
  564.        <td>--verbose (-v)</td>
  565.        <td>Increase verbosity of messages.</td>
  566.    </tr>
  567. <tr>
  568.        <td>--version (-V)</td>
  569.        <td>Display this application version.</td>
  570.    </tr>
  571. <tr>
  572.        <td>--ansi</td>
  573.        <td>Force ANSI output.</td>
  574.    </tr>
  575. <tr>
  576.        <td>--no-ansi</td>
  577.        <td>Disable ANSI output.</td>
  578.    </tr>
  579. <tr>
  580.        <td>--no-interaction (-n)</td>
  581.        <td>Do not ask any interactive question.</td>
  582.    </tr>
  583. <tr>
  584.        <td>--profile</td>
  585.        <td>Display timing and memory usage information</td>
  586.    </tr>
  587. <tr>
  588.        <td>--working-dir (-d)</td>
  589.        <td>If specified, use the given directory as working directory.</td>
  590.    </tr>
  591. </table>
  592. <br>
  593. <p>Help:<br/>
  594. The <info>init</info> command creates a basic composer.json file
  595.        in the current directory.
  596. <br>        <info>php composer.phar init</info>
  597.    </p>
  598. ]]></help>
  599.     </command>
  600.     <command>
  601.         <name>install</name>
  602.         <help><![CDATA[<h2>install</h2>
  603. <p>Usage:<br>
  604. install [--prefer-source] [--prefer-dist] [--dry-run] [--dev] [--no-custom-installers] [--no-scripts] [-v|--verbose]
  605. </p>
  606. <p>Installs the project dependencies from the composer.lock file if present, or falls back on the composer.json.
  607. </p>
  608. <table>
  609.    <tr><td><strong>Options:</strong></td></tr>
  610. <tr>
  611.        <td>--prefer-source</td>
  612.        <td>Forces installation from package sources when possible, including VCS information.</td>
  613.    </tr>
  614. <tr>
  615.        <td>--prefer-dist</td>
  616.        <td>Forces installation from package dist even for dev versions.</td>
  617.    </tr>
  618. <tr>
  619.        <td>--dry-run</td>
  620.        <td>Outputs the operations but will not execute anything (implicitly enables --verbose).</td>
  621.    </tr>
  622. <tr>
  623.        <td>--dev</td>
  624.        <td>Enables installation of dev-require packages.</td>
  625.    </tr>
  626. <tr>
  627.        <td>--no-custom-installers</td>
  628.        <td>Disables all custom installers.</td>
  629.    </tr>
  630. <tr>
  631.        <td>--no-scripts</td>
  632.        <td>Skips the execution of all scripts defined in composer.json file.</td>
  633.    </tr>
  634. <tr>
  635.        <td>--verbose (-v)</td>
  636.        <td>Increase verbosity of messages.</td>
  637.    </tr>
  638. <tr>
  639.        <td>--help (-h)</td>
  640.        <td>Display this help message.</td>
  641.    </tr>
  642. <tr>
  643.        <td>--quiet (-q)</td>
  644.        <td>Do not output any message.</td>
  645.    </tr>
  646. <tr>
  647.        <td>--version (-V)</td>
  648.        <td>Display this application version.</td>
  649.    </tr>
  650. <tr>
  651.        <td>--ansi</td>
  652.        <td>Force ANSI output.</td>
  653.    </tr>
  654. <tr>
  655.        <td>--no-ansi</td>
  656.        <td>Disable ANSI output.</td>
  657.    </tr>
  658. <tr>
  659.        <td>--no-interaction (-n)</td>
  660.        <td>Do not ask any interactive question.</td>
  661.    </tr>
  662. <tr>
  663.        <td>--profile</td>
  664.        <td>Display timing and memory usage information</td>
  665.    </tr>
  666. <tr>
  667.        <td>--working-dir (-d)</td>
  668.        <td>If specified, use the given directory as working directory.</td>
  669.    </tr>
  670. </table>
  671. <br>
  672. <p>Help:<br/>
  673. The <info>install</info> command reads the composer.lock file from
  674.        the current directory, processes it, and downloads and installs all the
  675.        libraries and dependencies outlined in that file. If the file does not
  676.        exist it will look for composer.json and do the same.
  677. <br>        <info>php composer.phar install</info>
  678.    </p>
  679. ]]></help>
  680.     </command>
  681.     <command>
  682.         <name>list</name>
  683.         <params>namespace[=null] </params>
  684.         <help><![CDATA[<h2>list</h2>
  685. <p>Usage:<br>
  686. list [--xml] [--raw] [namespace]
  687. </p>
  688. <p>Lists commands
  689. </p>
  690. <table>
  691.    <tr><td><strong>Arguments:</strong></td></tr>
  692.        <params><tr>
  693.        <td>namespace</td>
  694.        <td>The namespace name</td>
  695.    </tr>
  696. </table>
  697. <br>
  698. <table>
  699.    <tr><td><strong>Options:</strong></td></tr>
  700. <tr>
  701.        <td>--xml</td>
  702.        <td>To output help as XML</td>
  703.    </tr>
  704. <tr>
  705.        <td>--raw</td>
  706.        <td>To output raw command list</td>
  707.    </tr>
  708. </table>
  709. <br>
  710. <p>Help:<br/>
  711. The <info>list</info> command lists all commands:
  712. <br>        <info>php composer.phar list</info>
  713. <br>        You can also display the commands for a specific namespace:
  714. <br>        <info>php composer.phar list test</info>
  715. <br>        You can also output the information as XML by using the <comment>--xml</comment> option:
  716. <br>        <info>php composer.phar list --xml</info>
  717. <br>        It's also possible to get raw list of commands (useful for embedding command runner):
  718. <br>        <info>php composer.phar list --raw</info></p>
  719. ]]></help>
  720.     </command>
  721.     <command>
  722.         <name>require</name>
  723.         <params>packages[=null] </params>
  724.         <help><![CDATA[<h2>require</h2>
  725. <p>Usage:<br>
  726. require [--dev] [--prefer-source] [--prefer-dist] [--no-update] [packages1] ... [packagesN]
  727. </p>
  728. <p>Adds required packages to your composer.json and installs them
  729. </p>
  730. <table>
  731.    <tr><td><strong>Arguments:</strong></td></tr>
  732.        <params><tr>
  733.        <td>packages</td>
  734.        <td>Required package with a version constraint, e.g. foo/bar:1.0.0 or foo/bar=1.0.0 or "foo/bar 1.0.0"</td>
  735.    </tr>
  736. </table>
  737. <br>
  738. <table>
  739.    <tr><td><strong>Options:</strong></td></tr>
  740. <tr>
  741.        <td>--dev</td>
  742.        <td>Add requirement to require-dev.</td>
  743.    </tr>
  744. <tr>
  745.        <td>--prefer-source</td>
  746.        <td>Forces installation from package sources when possible, including VCS information.</td>
  747.    </tr>
  748. <tr>
  749.        <td>--prefer-dist</td>
  750.        <td>Forces installation from package dist even for dev versions.</td>
  751.    </tr>
  752. <tr>
  753.        <td>--no-update</td>
  754.        <td>Disables the automatic update of the dependencies.</td>
  755.    </tr>
  756. <tr>
  757.        <td>--help (-h)</td>
  758.        <td>Display this help message.</td>
  759.    </tr>
  760. <tr>
  761.        <td>--quiet (-q)</td>
  762.        <td>Do not output any message.</td>
  763.    </tr>
  764. <tr>
  765.        <td>--verbose (-v)</td>
  766.        <td>Increase verbosity of messages.</td>
  767.    </tr>
  768. <tr>
  769.        <td>--version (-V)</td>
  770.        <td>Display this application version.</td>
  771.    </tr>
  772. <tr>
  773.        <td>--ansi</td>
  774.        <td>Force ANSI output.</td>
  775.    </tr>
  776. <tr>
  777.        <td>--no-ansi</td>
  778.        <td>Disable ANSI output.</td>
  779.    </tr>
  780. <tr>
  781.        <td>--no-interaction (-n)</td>
  782.        <td>Do not ask any interactive question.</td>
  783.    </tr>
  784. <tr>
  785.        <td>--profile</td>
  786.        <td>Display timing and memory usage information</td>
  787.    </tr>
  788. <tr>
  789.        <td>--working-dir (-d)</td>
  790.        <td>If specified, use the given directory as working directory.</td>
  791.    </tr>
  792. </table>
  793. <br>
  794. <p>Help:<br/>
  795. The require command adds required packages to your composer.json and installs them
  796. <br>        If you do not want to install the new dependencies immediately you can call it with --no-update
  797.    </p>
  798. ]]></help>
  799.     </command>
  800.     <command>
  801.         <name>search</name>
  802.         <params>tokens </params>
  803.         <help><![CDATA[<h2>search</h2>
  804. <p>Usage:<br>
  805. search [-N|--only-name] tokens1 ... [tokensN]
  806. </p>
  807. <p>Search for packages
  808. </p>
  809. <table>
  810.    <tr><td><strong>Arguments:</strong></td></tr>
  811.        <params><tr>
  812.        <td>tokens</td>
  813.        <td>tokens to search for</td>
  814.    </tr>
  815. </table>
  816. <br>
  817. <table>
  818.    <tr><td><strong>Options:</strong></td></tr>
  819. <tr>
  820.        <td>--only-name (-N)</td>
  821.        <td>Search only in name</td>
  822.    </tr>
  823. <tr>
  824.        <td>--help (-h)</td>
  825.        <td>Display this help message.</td>
  826.    </tr>
  827. <tr>
  828.        <td>--quiet (-q)</td>
  829.        <td>Do not output any message.</td>
  830.    </tr>
  831. <tr>
  832.        <td>--verbose (-v)</td>
  833.        <td>Increase verbosity of messages.</td>
  834.    </tr>
  835. <tr>
  836.        <td>--version (-V)</td>
  837.        <td>Display this application version.</td>
  838.    </tr>
  839. <tr>
  840.        <td>--ansi</td>
  841.        <td>Force ANSI output.</td>
  842.    </tr>
  843. <tr>
  844.        <td>--no-ansi</td>
  845.        <td>Disable ANSI output.</td>
  846.    </tr>
  847. <tr>
  848.        <td>--no-interaction (-n)</td>
  849.        <td>Do not ask any interactive question.</td>
  850.    </tr>
  851. <tr>
  852.        <td>--profile</td>
  853.        <td>Display timing and memory usage information</td>
  854.    </tr>
  855. <tr>
  856.        <td>--working-dir (-d)</td>
  857.        <td>If specified, use the given directory as working directory.</td>
  858.    </tr>
  859. </table>
  860. <br>
  861. <p>Help:<br/>
  862. The search command searches for packages by its name
  863.        <info>php composer.phar search symfony composer</info>
  864.    </p>
  865. ]]></help>
  866.     </command>
  867.     <command>
  868.         <name>self-update</name>
  869.         <help><![CDATA[<h2>self-update</h2>
  870. <p>Usage:<br>
  871. self-update
  872. </p>
  873. <p>Updates composer.phar to the latest version.
  874. </p>
  875. <table>
  876.    <tr><td><strong>Options:</strong></td></tr>
  877. <tr>
  878.        <td>--help (-h)</td>
  879.        <td>Display this help message.</td>
  880.    </tr>
  881. <tr>
  882.        <td>--quiet (-q)</td>
  883.        <td>Do not output any message.</td>
  884.    </tr>
  885. <tr>
  886.        <td>--verbose (-v)</td>
  887.        <td>Increase verbosity of messages.</td>
  888.    </tr>
  889. <tr>
  890.        <td>--version (-V)</td>
  891.        <td>Display this application version.</td>
  892.    </tr>
  893. <tr>
  894.        <td>--ansi</td>
  895.        <td>Force ANSI output.</td>
  896.    </tr>
  897. <tr>
  898.        <td>--no-ansi</td>
  899.        <td>Disable ANSI output.</td>
  900.    </tr>
  901. <tr>
  902.        <td>--no-interaction (-n)</td>
  903.        <td>Do not ask any interactive question.</td>
  904.    </tr>
  905. <tr>
  906.        <td>--profile</td>
  907.        <td>Display timing and memory usage information</td>
  908.    </tr>
  909. <tr>
  910.        <td>--working-dir (-d)</td>
  911.        <td>If specified, use the given directory as working directory.</td>
  912.    </tr>
  913. </table>
  914. <br>
  915. <p>Help:<br/>
  916. The <info>self-update</info> command checks getcomposer.org for newer
  917.        versions of composer and if found, installs the latest.
  918. <br>        <info>php composer.phar self-update</info>
  919.    </p>
  920. ]]></help>
  921.     </command>
  922.     <command>
  923.         <name>selfupdate</name>
  924.         <help><![CDATA[<h2>selfupdate</h2>
  925. <p>Usage:<br>
  926. selfupdate
  927. </p>
  928. <p>Updates composer.phar to the latest version.
  929. </p>
  930. <table>
  931.    <tr><td><strong>Options:</strong></td></tr>
  932. <tr>
  933.        <td>--help (-h)</td>
  934.        <td>Display this help message.</td>
  935.    </tr>
  936. <tr>
  937.        <td>--quiet (-q)</td>
  938.        <td>Do not output any message.</td>
  939.    </tr>
  940. <tr>
  941.        <td>--verbose (-v)</td>
  942.        <td>Increase verbosity of messages.</td>
  943.    </tr>
  944. <tr>
  945.        <td>--version (-V)</td>
  946.        <td>Display this application version.</td>
  947.    </tr>
  948. <tr>
  949.        <td>--ansi</td>
  950.        <td>Force ANSI output.</td>
  951.    </tr>
  952. <tr>
  953.        <td>--no-ansi</td>
  954.        <td>Disable ANSI output.</td>
  955.    </tr>
  956. <tr>
  957.        <td>--no-interaction (-n)</td>
  958.        <td>Do not ask any interactive question.</td>
  959.    </tr>
  960. <tr>
  961.        <td>--profile</td>
  962.        <td>Display timing and memory usage information</td>
  963.    </tr>
  964. <tr>
  965.        <td>--working-dir (-d)</td>
  966.        <td>If specified, use the given directory as working directory.</td>
  967.    </tr>
  968. </table>
  969. <br>
  970. <p>Help:<br/>
  971. The <info>self-update</info> command checks getcomposer.org for newer
  972.        versions of composer and if found, installs the latest.
  973. <br>        <info>php composer.phar self-update</info>
  974.    </p>
  975. ]]></help>
  976.     </command>
  977.     <command>
  978.         <name>show</name>
  979.         <params>package[=null] version[=null] </params>
  980.         <help><![CDATA[<h2>show</h2>
  981. <p>Usage:<br>
  982. show [-i|--installed] [-p|--platform] [-s|--self] [--dev] [package] [version]
  983. </p>
  984. <p>Show information about packages
  985. </p>
  986. <table>
  987.    <tr><td><strong>Arguments:</strong></td></tr>
  988.        <params><tr>
  989.        <td>package</td>
  990.        <td>Package to inspect</td>
  991.    </tr>
  992. <tr>
  993.        <td>version</td>
  994.        <td>Version to inspect</td>
  995.    </tr>
  996. </table>
  997. <br>
  998. <table>
  999.    <tr><td><strong>Options:</strong></td></tr>
  1000. <tr>
  1001.        <td>--installed (-i)</td>
  1002.        <td>List installed packages only</td>
  1003.    </tr>
  1004. <tr>
  1005.        <td>--platform (-p)</td>
  1006.        <td>List platform packages only</td>
  1007.    </tr>
  1008. <tr>
  1009.        <td>--self (-s)</td>
  1010.        <td>Show the root package information</td>
  1011.    </tr>
  1012. <tr>
  1013.        <td>--dev</td>
  1014.        <td>Enables display of dev-require packages.</td>
  1015.    </tr>
  1016. <tr>
  1017.        <td>--help (-h)</td>
  1018.        <td>Display this help message.</td>
  1019.    </tr>
  1020. <tr>
  1021.        <td>--quiet (-q)</td>
  1022.        <td>Do not output any message.</td>
  1023.    </tr>
  1024. <tr>
  1025.        <td>--verbose (-v)</td>
  1026.        <td>Increase verbosity of messages.</td>
  1027.    </tr>
  1028. <tr>
  1029.        <td>--version (-V)</td>
  1030.        <td>Display this application version.</td>
  1031.    </tr>
  1032. <tr>
  1033.        <td>--ansi</td>
  1034.        <td>Force ANSI output.</td>
  1035.    </tr>
  1036. <tr>
  1037.        <td>--no-ansi</td>
  1038.        <td>Disable ANSI output.</td>
  1039.    </tr>
  1040. <tr>
  1041.        <td>--no-interaction (-n)</td>
  1042.        <td>Do not ask any interactive question.</td>
  1043.    </tr>
  1044. <tr>
  1045.        <td>--profile</td>
  1046.        <td>Display timing and memory usage information</td>
  1047.    </tr>
  1048. <tr>
  1049.        <td>--working-dir (-d)</td>
  1050.        <td>If specified, use the given directory as working directory.</td>
  1051.    </tr>
  1052. </table>
  1053. <br>
  1054. <p>Help:<br/>
  1055. The show command displays detailed information about a package, or
  1056.        lists all packages available.
  1057.    </p>
  1058. ]]></help>
  1059.     </command>
  1060.     <command>
  1061.         <name>status</name>
  1062.         <help><![CDATA[<h2>status</h2>
  1063. <p>Usage:<br>
  1064. status [-v|--verbose]
  1065. </p>
  1066. <p>Show a list of locally modified packages
  1067. </p>
  1068. <table>
  1069.    <tr><td><strong>Options:</strong></td></tr>
  1070. <tr>
  1071.        <td>--verbose (-v)</td>
  1072.        <td>Increase verbosity of messages.</td>
  1073.    </tr>
  1074. <tr>
  1075.        <td>--help (-h)</td>
  1076.        <td>Display this help message.</td>
  1077.    </tr>
  1078. <tr>
  1079.        <td>--quiet (-q)</td>
  1080.        <td>Do not output any message.</td>
  1081.    </tr>
  1082. <tr>
  1083.        <td>--version (-V)</td>
  1084.        <td>Display this application version.</td>
  1085.    </tr>
  1086. <tr>
  1087.        <td>--ansi</td>
  1088.        <td>Force ANSI output.</td>
  1089.    </tr>
  1090. <tr>
  1091.        <td>--no-ansi</td>
  1092.        <td>Disable ANSI output.</td>
  1093.    </tr>
  1094. <tr>
  1095.        <td>--no-interaction (-n)</td>
  1096.        <td>Do not ask any interactive question.</td>
  1097.    </tr>
  1098. <tr>
  1099.        <td>--profile</td>
  1100.        <td>Display timing and memory usage information</td>
  1101.    </tr>
  1102. <tr>
  1103.        <td>--working-dir (-d)</td>
  1104.        <td>If specified, use the given directory as working directory.</td>
  1105.    </tr>
  1106. </table>
  1107. <br>
  1108. <p>Help:<br/>
  1109. The status command displays a list of dependencies that have
  1110.        been modified locally.
  1111.    </p>
  1112. ]]></help>
  1113.     </command>
  1114.     <command>
  1115.         <name>update</name>
  1116.         <params>packages[=null] </params>
  1117.         <help><![CDATA[<h2>update</h2>
  1118. <p>Usage:<br>
  1119. update [--prefer-source] [--prefer-dist] [--dry-run] [--dev] [--no-custom-installers] [--no-scripts] [-v|--verbose] [packages1] ... [packagesN]
  1120. </p>
  1121. <p>Updates your dependencies to the latest version according to composer.json, and updates the composer.lock file.
  1122. </p>
  1123. <table>
  1124.    <tr><td><strong>Arguments:</strong></td></tr>
  1125.        <params><tr>
  1126.        <td>packages</td>
  1127.        <td>Packages that should be updated, if not provided all packages are.</td>
  1128.    </tr>
  1129. </table>
  1130. <br>
  1131. <table>
  1132.    <tr><td><strong>Options:</strong></td></tr>
  1133. <tr>
  1134.        <td>--prefer-source</td>
  1135.        <td>Forces installation from package sources when possible, including VCS information.</td>
  1136.    </tr>
  1137. <tr>
  1138.        <td>--prefer-dist</td>
  1139.        <td>Forces installation from package dist even for dev versions.</td>
  1140.    </tr>
  1141. <tr>
  1142.        <td>--dry-run</td>
  1143.        <td>Outputs the operations but will not execute anything (implicitly enables --verbose).</td>
  1144.    </tr>
  1145. <tr>
  1146.        <td>--dev</td>
  1147.        <td>Enables installation of dev-require packages.</td>
  1148.    </tr>
  1149. <tr>
  1150.        <td>--no-custom-installers</td>
  1151.        <td>Disables all custom installers.</td>
  1152.    </tr>
  1153. <tr>
  1154.        <td>--no-scripts</td>
  1155.        <td>Skips the execution of all scripts defined in composer.json file.</td>
  1156.    </tr>
  1157. <tr>
  1158.        <td>--verbose (-v)</td>
  1159.        <td>Increase verbosity of messages.</td>
  1160.    </tr>
  1161. <tr>
  1162.        <td>--help (-h)</td>
  1163.        <td>Display this help message.</td>
  1164.    </tr>
  1165. <tr>
  1166.        <td>--quiet (-q)</td>
  1167.        <td>Do not output any message.</td>
  1168.    </tr>
  1169. <tr>
  1170.        <td>--version (-V)</td>
  1171.        <td>Display this application version.</td>
  1172.    </tr>
  1173. <tr>
  1174.        <td>--ansi</td>
  1175.        <td>Force ANSI output.</td>
  1176.    </tr>
  1177. <tr>
  1178.        <td>--no-ansi</td>
  1179.        <td>Disable ANSI output.</td>
  1180.    </tr>
  1181. <tr>
  1182.        <td>--no-interaction (-n)</td>
  1183.        <td>Do not ask any interactive question.</td>
  1184.    </tr>
  1185. <tr>
  1186.        <td>--profile</td>
  1187.        <td>Display timing and memory usage information</td>
  1188.    </tr>
  1189. <tr>
  1190.        <td>--working-dir (-d)</td>
  1191.        <td>If specified, use the given directory as working directory.</td>
  1192.    </tr>
  1193. </table>
  1194. <br>
  1195. <p>Help:<br/>
  1196. The <info>update</info> command reads the composer.json file from the
  1197.        current directory, processes it, and updates, removes or installs all the
  1198.        dependencies.
  1199. <br>        <info>php composer.phar update</info>
  1200. <br>        To limit the update operation to a few packages, you can list the package(s)
  1201.        you want to update as such:
  1202. <br>        <info>php composer.phar update vendor/package1 foo/mypackage [...]</info></p>
  1203. ]]></help>
  1204.     </command>
  1205.     <command>
  1206.         <name>validate</name>
  1207.         <params>file[=null] </params>
  1208.         <help><![CDATA[<h2>validate</h2>
  1209. <p>Usage:<br>
  1210. validate [file]
  1211. </p>
  1212. <p>Validates a composer.json
  1213. </p>
  1214. <table>
  1215.    <tr><td><strong>Arguments:</strong></td></tr>
  1216.        <params><tr>
  1217.        <td>file</td>
  1218.        <td>path to composer.json file</td>
  1219.    </tr>
  1220. </table>
  1221. <br>
  1222. <table>
  1223.    <tr><td><strong>Options:</strong></td></tr>
  1224. <tr>
  1225.        <td>--help (-h)</td>
  1226.        <td>Display this help message.</td>
  1227.    </tr>
  1228. <tr>
  1229.        <td>--quiet (-q)</td>
  1230.        <td>Do not output any message.</td>
  1231.    </tr>
  1232. <tr>
  1233.        <td>--verbose (-v)</td>
  1234.        <td>Increase verbosity of messages.</td>
  1235.    </tr>
  1236. <tr>
  1237.        <td>--version (-V)</td>
  1238.        <td>Display this application version.</td>
  1239.    </tr>
  1240. <tr>
  1241.        <td>--ansi</td>
  1242.        <td>Force ANSI output.</td>
  1243.    </tr>
  1244. <tr>
  1245.        <td>--no-ansi</td>
  1246.        <td>Disable ANSI output.</td>
  1247.    </tr>
  1248. <tr>
  1249.        <td>--no-interaction (-n)</td>
  1250.        <td>Do not ask any interactive question.</td>
  1251.    </tr>
  1252. <tr>
  1253.        <td>--profile</td>
  1254.        <td>Display timing and memory usage information</td>
  1255.    </tr>
  1256. <tr>
  1257.        <td>--working-dir (-d)</td>
  1258.        <td>If specified, use the given directory as working directory.</td>
  1259.    </tr>
  1260. </table>
  1261. <br>
  1262. <p>Help:<br/>
  1263. The validate command validates a given composer.json
  1264.    </p>
  1265. ]]></help>
  1266.     </command>
  1267.  <help><![CDATA[<p>Usage:<br>
  1268.    [options] command [arguments]
  1269. </p>
  1270. <br>
  1271. <table>
  1272.    <tr><td><strong>Options:</strong></td></tr>
  1273.    <tr><td>--help (-h)</td><td>Display this help message.</td></tr>
  1274.    <tr><td>--quiet (-q)</td><td>Do not output any message.</td></tr>
  1275.    <tr><td>--verbose (-v)</td><td>Increase verbosity of messages.</td></tr>
  1276.    <tr><td>--version (-V)</td><td>Display this application version.</td></tr>
  1277.    <tr><td>--ansi</td><td>Force ANSI output.</td></tr>
  1278.    <tr><td>--no-ansi</td><td>Disable ANSI output.</td></tr>
  1279.    <tr><td>--no-interaction (-n)</td><td>Do not ask any interactive question.</td></tr>
  1280.    <tr><td>--profile</td><td>Display timing and memory usage information</td></tr>
  1281.    <tr><td>--working-dir (-d)</td><td>If specified, use the given directory as working directory.</td></tr>
  1282. </table>
  1283. <br>
  1284. <table>
  1285.    <tr><td><strong>Available commands:</strong></td></tr>
  1286.    <tr>
  1287.        <td>about</td>
  1288.        <td>Short information about Composer</td>
  1289.    </tr>
  1290.    <tr>
  1291.        <td>config</td>
  1292.        <td>Set config options</td>
  1293.    </tr>
  1294.    <tr>
  1295.        <td>create-project</td>
  1296.        <td>Create new project from a package into given directory.</td>
  1297.    </tr>
  1298.    <tr>
  1299.        <td>depends</td>
  1300.        <td>Shows which packages depend on the given package</td>
  1301.    </tr>
  1302.    <tr>
  1303.        <td>dump-autoload</td>
  1304.        <td>dumps the autoloader</td>
  1305.    </tr>
  1306.    <tr>
  1307.        <td>dumpautoload</td>
  1308.        <td>dumps the autoloader</td>
  1309.    </tr>
  1310.    <tr>
  1311.        <td>help</td>
  1312.        <td>Displays help for a command</td>
  1313.    </tr>
  1314.    <tr>
  1315.        <td>init</td>
  1316.        <td>Creates a basic composer.json file in current directory.</td>
  1317.    </tr>
  1318.    <tr>
  1319.        <td>install</td>
  1320.        <td>Installs the project dependencies from the composer.lock file if present, or falls back on the composer.json.</td>
  1321.    </tr>
  1322.    <tr>
  1323.        <td>list</td>
  1324.        <td>Lists commands</td>
  1325.    </tr>
  1326.    <tr>
  1327.        <td>require</td>
  1328.        <td>Adds required packages to your composer.json and installs them</td>
  1329.    </tr>
  1330.    <tr>
  1331.        <td>search</td>
  1332.        <td>Search for packages</td>
  1333.    </tr>
  1334.    <tr>
  1335.        <td>self-update</td>
  1336.        <td>Updates composer.phar to the latest version.</td>
  1337.    </tr>
  1338.    <tr>
  1339.        <td>selfupdate</td>
  1340.        <td>Updates composer.phar to the latest version.</td>
  1341.    </tr>
  1342.    <tr>
  1343.        <td>show</td>
  1344.        <td>Show information about packages</td>
  1345.    </tr>
  1346.    <tr>
  1347.        <td>status</td>
  1348.        <td>Show a list of locally modified packages</td>
  1349.    </tr>
  1350.    <tr>
  1351.        <td>update</td>
  1352.        <td>Updates your dependencies to the latest version according to composer.json, and updates the composer.lock file.</td>
  1353.    </tr>
  1354.    <tr>
  1355.        <td>validate</td>
  1356.        <td>Validates a composer.json</td>
  1357.    </tr>
  1358. </table>
  1359. </p>]]></help>
  1360. </framework>
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement