@program_prefix@php \- PHP Command Line Interface 'CLI'

.P

@program_prefix@php-cgi \- PHP Common Gateway Interface 'CGI' command

.B @program_prefix@php

[options] [

.B \-f\fP ]

.IR file

[[\-\-]

.IR args.\|.\|. ]

.LP

.B @program_prefix@php

[options]

.B \-r

.IR code

[[\-\-]

.IR args.\|.\|. ]

.LP

.B @program_prefix@php

[options] [\-B

.IR begin_code ]

.B \-R

.IR code

[\-E

.IR end_code ]

[[\-\-]

.IR args.\|.\|. ]

.LP

.B @program_prefix@php

[options] [\-B

.IR begin_code ]

.B \-F

.IR file

[\-E

.IR end_code ]

[[\-\-]

.IR args.\|.\|. ]

.LP

.B @program_prefix@php

[options] \-\- [

.IR args.\|.\|. ]

.LP

\fB@program_prefix@php \fP[options] \fB\-a\fP

.LP

.B @program_prefix@php

[options] \-S

.IR addr:port

[\-t

.IR docroot ]

.LP

\fBPHP\fP is a widely\-used general\-purpose scripting language that is especially suited for

Web development and can be embedded into HTML. This is the command line interface

that enables you to do the following:

.P

You can parse and execute files by using parameter \-f followed by the name of the

.IR file

to be executed.

.LP

Using parameter \-r you can directly execute PHP

.IR code

simply as you would do inside a

.B \.php

file when using the

.B eval()

function.

.LP

It is also possible to process the standard input line by line using either

the parameter \-R or \-F. In this mode each separate input line causes the

.IR code

specified by \-R or the

.IR file

specified by \-F to be executed.

You can access the input line by \fB$argn\fP. While processing the input lines

.B $argi

contains the number of the actual line being processed. Further more

the parameters \-B and \-E can be used to execute

.IR code

(see \-r) before and

after all input lines have been processed respectively. Notice that the

input is read from

.B STDIN

and therefore reading from

.B STDIN

explicitly changes the next input line or skips input lines.

.LP

PHP also contains an built-in web server for application development purpose. By using the \-S option where

.B addr:port

point to a local address and port PHP will listen to HTTP requests on that address and port and serve files from the current working directory or the

.B docroot

passed by the \-t option.

.LP

If a PHP file is provided to the command line when the

built-in web server is used, it will be used as the router script. This script

will be started at each HTTP request. The script output is returned to the

browser, unless the router script returns the

.B false

value. If so, the built-in server falls back to the default behaviour, returning

the requested resource as-is by looking up the files relative to the document

root specified by the \-t option, if provided.

.LP

If none of \-r \-f \-B \-R \-F \-E or \-S is present but a single parameter is given

then this parameter is taken as the filename to parse and execute (same as

with \-f). If no parameter is present then the standard input is read and

executed.

.TP 15

.B \-\-interactive

.TP

.B \-a

Run PHP interactively. This lets you enter snippets of PHP code that directly

get executed. When readline support is enabled you can edit the lines and also

have history support.

.TP

.B \-\-bindpath \fIaddress:port\fP|\fIport\fP

.TP

.B \-b \fIaddress:port\fP|\fIport\fP

Bind Path for external FASTCGI Server mode (CGI only).

.TP

.B \-\-no\-chdir

.TP

.B \-C

Do not chdir to the script's directory (CGI only).

.TP

.B \-\-no\-header

.TP

.B \-q

Quiet-mode. Suppress HTTP header output (CGI only).

.TP

.B \-\-timing \fIcount\fP

.TP

.B \-T \fIcount\fP

Measure execution time of script repeated count times (CGI only).

.TP

.B \-\-php\-ini \fIpath\fP|\fIfile\fP

.TP

.B \-c \fIpath\fP|\fIfile\fP

Look for

.B php.ini

file in the directory

.IR path

or use the specified

.IR file

.TP

.B \-\-no\-php\-ini

.TP

.B \-n

No

.B php.ini

file will be used

.TP

.B \-\-define \fIfoo\fP[=\fIbar\fP]

.TP

.B \-d \fIfoo\fP[=\fIbar\fP]

Define INI entry

.IR foo

with value

.IR bar

.TP

Generate extended information for debugger/profiler

.TP

.B \-\-file \fIfile\fP

.TP

.B \-f \fIfile\fP

Parse and execute

.IR file

.TP

.B \-\-help

.TP

.B \-h

This help

.TP

.B \-\-hide\-args

.TP

.B \-H

Hide script name (\fIfile\fP) and parameters (\fIargs\.\.\.\fP) from external

tools. For example you may want to use this when a php script is started as

a daemon and the command line contains sensitive data such as passwords.

.TP

.B \-\-info

.TP

.B \-i

PHP information and configuration

.TP

.B \-\-syntax\-check

.TP

.B \-l

Syntax check only (lint)

.TP

.B \-\-modules

.TP

.B \-m

Show compiled in modules

.TP

.B \-\-run \fIcode\fP

.TP

.B \-r \fIcode\fP

Run PHP

.IR code

without using script tags

.B '<?..?>'

.TP

.B \-\-process\-begin \fIcode\fP

.TP

.B \-B \fIbegin_code\fP

Run PHP

.IR begin_code

before processing input lines

.TP

.B \-\-process\-code \fIcode\fP

.TP

.B \-R \fIcode\fP

Run PHP

.IR code

for every input line

.TP

.B \-\-process\-file \fIfile\fP

.TP

.B \-F \fIfile\fP

Parse and execute

.IR file

for every input line

.TP

.B \-\-process\-end \fIcode\fP

.TP

.B \-E \fIend_code\fP

Run PHP

.IR end_code

after processing all input lines

.TP

.B \-\-syntax\-highlight

.TP

.B \-s

Output HTML syntax highlighted source

.TP

.B \-\-server \fIaddr:port\fP

.TP

.B \-S \fIaddr:port\fP

Start built-in web server on the given local address and port

.TP

.B \-\-docroot \fIdocroot\fP

.TP

.B \-t \fIdocroot\fP

Specify the document root to be used by the built-in web server

.TP

.B \-\-version

.TP

.B \-v

Version number

.TP

.B \-\-strip

.TP

.B \-w

Output source with stripped comments and whitespace

.IR file

.TP

Arguments passed to script. Use

.B '\-\-'

.IR args

when first argument starts with

.B '\-'

or script is read from stdin

.TP

.B \-\-rfunction

.IR name

.TP

.B \-\-rf

.IR name

Shows information about function

.B name

.TP

.B \-\-rclass

.IR name

.TP

.B \-\-rc

.IR name

Shows information about class

.B name

.TP

.B \-\-rextension

.IR name

.TP

.B \-\-re

.IR name

Shows information about extension

.B name

.TP

.B \-\-rzendextension

.IR name

.TP

.B \-\-rz

.IR name

Shows information about Zend extension

.B name

.TP

.B \-\-rextinfo

.IR name

.TP

.B \-\-ri

.IR name

Shows configuration for extension

.B name

.TP

Show configuration file names

.TP 15

The configuration file for the CLI version of PHP.

.TP

The standard configuration file will only be used when

.B php\-cli.ini

cannot be found.

.TP 5

This command simply writes the text "Hello World" to standard out.

.TP

This shows the configuration of your gd extension. You can use this

to easily check which image formats you can use. If you have any

dynamic modules you may want to use the same ini file that php uses

when executed from your webserver. There are more extensions which

have such a function. For dba use:

.RS

\fI@program_prefix@php \-r 'print_r(dba_handlers(1));'\fP

.RE

.TP

This PHP command strips off the HTML tags line by line and outputs the

result. To see how it works you can first look at the following PHP command

\'\fIphp \-d html_errors=1 \-i\fP\' which uses PHP to output HTML formatted

configuration information. If you then combine those two

\'\fIphp \.\.\.|php \.\.\.\fP\' you'll see what happens.

.TP

Using this PHP command you can count the lines being input.

.TP

In this example PHP expects each input line being a file. It counts all lines

of the files specified by each input line and shows the summarized result.

You may combine this with tools like find and change the php scriptlet.

.TP

Since you have access to STDIN from within \-B \-R \-F and \-E you can skip

certain input lines with your code. But note that in such cases $argi only

counts the lines being processed by php itself. Having read this you will

guess what the above program does: skipping every second input line.

You can use a shebang line to automatically invoke php

from scripts. Only the CLI version of PHP will ignore

such a first line as shown below:

.P

.PD 0

.RS

#!/bin/php

.P

<?php

.P

// your script

.P

?>

.RE

.PD 1

.P

For a more or less complete description of PHP look here:

.PD 0

.P

.B https://www.php.net/manual/

.PD 1

.P

You can view the list of known bugs or report any new bug you

found at:

.PD 0

.P

.B https://github.com/php/php-src/issues

.PD 1

The PHP Group: Thies C. Arntzen, Stig Bakken, Andi Gutmans, Rasmus Lerdorf, Sam Ruby, Sascha Schumann, Zeev Suraski, Jim Winstead, Andrei Zmievski.

.P

Additional work for the CLI sapi was done by Edin Kadribasic, Marcus Boerger and Johannes Schlueter.

.P

A List of active developers can be found here:

.PD 0

.P

.B https://www.php.net/credits.php

.PD 1

.P

And last but not least PHP was developed with the help of a huge amount of

contributors all around the world.

This manpage describes \fBphp\fP, version @PHP_VERSION@.

Copyright \(co The PHP Group and Contributors

.LP

This source file is subject to the Modified BSD License that is

bundled with this package in the file LICENSE, and is available

through the World Wide Web at

.B https://www.php.net/license/