|
| 1 | +'\" t |
| 2 | +.\" Title: puli |
| 3 | +.\" Author: [see the "AUTHOR" section] |
| 4 | +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> |
| 5 | +.\" Date: 01/27/2015 |
| 6 | +.\" Manual: \ \& |
| 7 | +.\" Source: \ \& |
| 8 | +.\" Language: English |
| 9 | +.\" |
| 10 | +.TH "PULI" "1" "01/27/2015" "\ \&" "\ \&" |
| 11 | +.\" ----------------------------------------------------------------- |
| 12 | +.\" * Define some portability stuff |
| 13 | +.\" ----------------------------------------------------------------- |
| 14 | +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 15 | +.\" http://bugs.debian.org/507673 |
| 16 | +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
| 17 | +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 18 | +.ie \n(.g .ds Aq \(aq |
| 19 | +.el .ds Aq ' |
| 20 | +.\" ----------------------------------------------------------------- |
| 21 | +.\" * set default formatting |
| 22 | +.\" ----------------------------------------------------------------- |
| 23 | +.\" disable hyphenation |
| 24 | +.nh |
| 25 | +.\" disable justification (adjust text to left margin only) |
| 26 | +.ad l |
| 27 | +.\" ----------------------------------------------------------------- |
| 28 | +.\" * MAIN CONTENT STARTS HERE * |
| 29 | +.\" ----------------------------------------------------------------- |
| 30 | +.SH "NAME" |
| 31 | +puli \- PHP\*(Aqs powerful resource manager |
| 32 | +.SH "SYNOPSIS" |
| 33 | +.sp |
| 34 | +.nf |
| 35 | +\fIpuli\fR [\-\-help] [\-\-quiet] [\-\-verbose] [\-\-version] [\-\-ansi] |
| 36 | + [\-\-no\-ansi] [\-\-no\-interaction] |
| 37 | + <command> [<sub \-command>] [<arg1>] \&... [<argN>] |
| 38 | +.fi |
| 39 | +.SH "DESCRIPTION" |
| 40 | +.sp |
| 41 | +Puli is a PHP library that manages files, directories and other resources in a repository \- much like a virtual file system\&. \fIResources\fR can be anything, but usually we use the term for machine\-processed files that are not PHP, such as CSS, JavaScript, XLIFF, YAML, XML or HTML files\&. |
| 42 | +.SH "ARGUMENTS" |
| 43 | +.PP |
| 44 | +<command> |
| 45 | +.RS 4 |
| 46 | +The name of the command to execute\&. The list of commands is displayed in the output of |
| 47 | +\fBpuli\fR\&. |
| 48 | +.RE |
| 49 | +.PP |
| 50 | +<sub\-command> |
| 51 | +.RS 4 |
| 52 | +Some Puli commands have sub\-commands\&. Pass the name of a sub\-command in this argument\&. You can list the commands and their sub\-commands with |
| 53 | +\fBpuli \-a\fR\&. |
| 54 | +.RE |
| 55 | +.PP |
| 56 | +<arg*> |
| 57 | +.RS 4 |
| 58 | +The arguments of the command\&. Run |
| 59 | +\fBpuli <command> \-h\fR |
| 60 | +to learn more about the arguments supported by a command\&. |
| 61 | +.RE |
| 62 | +.SH "OPTIONS" |
| 63 | +.PP |
| 64 | +\-\-help, \-h |
| 65 | +.RS 4 |
| 66 | +Print the synopsis and a list of the most commonly used commands\&. |
| 67 | +.RE |
| 68 | +.PP |
| 69 | +\-\-quiet, \-q |
| 70 | +.RS 4 |
| 71 | +Mute all output of the command\&. |
| 72 | +.RE |
| 73 | +.PP |
| 74 | +\-\-verbose, \-v, \-vv, \-vvv |
| 75 | +.RS 4 |
| 76 | +Enable verbose output of the command\&. You can enable three levels of verbosity\&. The option |
| 77 | +\fI\-v\fR |
| 78 | +enables slightly verbose, |
| 79 | +\fI\-vv\fR |
| 80 | +more verbose and |
| 81 | +\fI\-vvv\fR |
| 82 | +very verbose output\&. |
| 83 | +.RE |
| 84 | +.PP |
| 85 | +\-\-version, \-V |
| 86 | +.RS 4 |
| 87 | +Print the version of Puli\&. |
| 88 | +.RE |
| 89 | +.PP |
| 90 | +\-\-ansi |
| 91 | +.RS 4 |
| 92 | +Enable colorization of the output\&. If the terminal supports colorization, the output will be colorized by default\&. |
| 93 | +.RE |
| 94 | +.PP |
| 95 | +\-\-no\-ansi |
| 96 | +.RS 4 |
| 97 | +Disable output colorization\&. This is useful if you want to process the output of a command in a script\&. |
| 98 | +.RE |
| 99 | +.PP |
| 100 | +\-\-no\-interaction, \-n |
| 101 | +.RS 4 |
| 102 | +Disable all dialogs and assumes the suggested answers\&. This is useful for running a command in a script\&. |
| 103 | +.RE |
| 104 | +.SH "LICENSE" |
| 105 | +.sp |
| 106 | +The MIT License (MIT) |
| 107 | +.sp |
| 108 | +Copyright (c) 2014 Bernhard Schussek |
| 109 | +.sp |
| 110 | +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: |
| 111 | +.sp |
| 112 | +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software\&. |
| 113 | +.sp |
| 114 | +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT\&. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE\&. |
| 115 | +.SH "AUTHOR" |
| 116 | +.sp |
| 117 | +Written by Bernhard Schussek <\m[blue]\fBbschussek@gmail\&.com\fR\m[]\&\s-2\u[1]\d\s+2> |
| 118 | +.SH "NOTES" |
| 119 | +.IP " 1." 4 |
| 120 | +bschussek@gmail.com |
| 121 | +.RS 4 |
| 122 | +\%mailto:bschussek@gmail.com |
| 123 | +.RE |
0 commit comments