Annotation of embedaddon/php/sapi/fpm/php-fpm.8.in, revision 1.1.1.3
1.1 misho 1: .TH PHP-FPM 8 "2009" "The PHP Group" "Scripting Language"
2: .SH NAME
3: .TP 15
4: php-fpm \- PHP FastCGI Process Manager 'PHP-FPM'
5: .SH SYNOPSIS
6: .B php-fpm
7: [options]
8: .LP
9: .SH DESCRIPTION
10: \fBPHP\fP is a widely\-used general\-purpose scripting language that is especially suited for
11: Web development and can be embedded into HTML. This is a variant of PHP that will run in the background as a daemon, listening for CGI requests. Output is logged to @php_fpm_localstatedir@/log/php-fpm.log.
12: .LP
13: Most options are set in the configuration file. The configuration file is @php_fpm_sysconfdir@/php-fpm.conf. By default, php-fpm will respond to CGI requests listening on localhost http port 9000. Therefore php-fpm expects your webserver to forward all requests for '.php' files to port 9000 and you should edit your webserver configuration file appropriately.
14: .SH OPTIONS
15: .TP 15
16: .B \-C
17: Do not chdir to the script's directory
18: .TP
19: .PD 0
20: .B \-\-php\-ini \fIpath\fP|\fIfile\fP
21: .TP
22: .PD 1
23: .B \-c \fIpath\fP|\fIfile\fP
24: Look for
25: .B php.ini
26: file in the directory
27: .IR path
28: or use the specified
29: .IR file
30: .TP
31: .PD 0
32: .B \-\-no\-php\-ini
33: .TP
34: .PD 1
35: .B \-n
36: No
37: .B php.ini
38: file will be used
39: .TP
40: .PD 0
41: .B \-\-define \fIfoo\fP[=\fIbar\fP]
42: .TP
43: .PD 1
44: .B \-d \fIfoo\fP[=\fIbar\fP]
45: Define INI entry
46: .IR foo
47: with value
48: .IR bar
49: .TP
50: .B \-e
51: Generate extended information for debugger/profiler
52: .TP
53: .PD 0
54: .B \-\-help
55: .TP
56: .PD 1
57: .B \-h
58: This help
59: .TP
60: .PD 0
61: .B \-\-info
62: .TP
63: .PD 1
64: .B \-i
65: PHP information and configuration
66: .TP
67: .PD 0
68: .B \-\-modules
69: .TP
70: .PD 1
71: .B \-m
72: Show compiled in modules
73: .TP
74: .PD 0
75: .B \-\-version
76: .TP
77: .PD 1
78: .B \-v
79: Version number
80: .B \-\-prefix \fIpath\fP
81: .TP
82: .PD 1
83: .B \-p
84: Specify alternative prefix path (the default is @php_fpm_prefix@)
85: .TP
86: .PD 0
87: .B \-\-fpm\-config \fIfile\fP
88: .TP
89: .PD 1
90: .B \-y
91: Specify alternative path to FastCGI process manager configuration file (the default is @php_fpm_sysconfdir@/php-fpm.conf)
92: .TP
93: .PD 0
94: .B \-\-test
95: .TP
96: .PD 1
97: .B \-t
98: Test FPM configuration file and exit
1.1.1.3 ! misho 99: If called twice (\-tt), the configuration is dumped before exiting.
1.1 misho 100: .TP
101: .PD 0
1.1.1.2 misho 102: .B \-\-daemonize
103: .TP
104: .PD 1
105: .B \-D
106: Force to run in background and ignore daemonize option from configuration file.
107: .TP
108: .PD 0
109: .B \-\-nodaemonize
110: .TP
111: .PD 1
112: .B \-F
113: Force to stay in foreground and ignore daemonize option from configuration file.
114: .TP
115: .PD 0
1.1 misho 116: .B \-\-zend\-extension \fIfile\fP
117: .TP
118: .PD 1
119: .B \-z \fIfile\fP
120: Load Zend extension
121: .IR file
122: .SH FILES
123: .TP 15
124: .B php-fpm.conf
125: The configuration file for the php-fpm daemon.
126: .TP
127: .B php.ini
128: The standard php configuration file.
129: .SH EXAMPLES
1.1.1.2 misho 130: For any unix systems which use init.d for their main process manager, you should use the init script provided to start and stop the php-fpm daemon.
1.1 misho 131: .P
132: .PD 1
133: .RS
134: sudo /etc/init.d/php-fpm start
135: .RE
136: .TP
1.1.1.2 misho 137: For any unix systems which use systemd for their main process manager, you should use the unit file provided to start and stop the php-fpm daemon.
138: .P
139: .PD 1
140: .RS
141: sudo systemctl start php-fpm.service
142: .RE
143: .TP
1.1 misho 144: If your installation has no appropriate init script, launch php-fpm with no arguments. It will launch as a daemon (background process) by default. The file @php_fpm_localstatedir@/run/php-fpm.pid determines whether php-fpm is already up and running. Once started, php-fpm then responds to several POSIX signals:
145: .P
146: .PD 0
147: .RS
148: .B SIGINT,SIGTERM \fPimmediate termination
149: .TP
150: .B SIGQUIT \fPgraceful stop
151: .TP
152: .B SIGUSR1 \fPre-open log file
153: .TP
154: .B SIGUSR2 \fPgraceful reload of all workers + reload of fpm conf/binary
155: .RE
156: .PD 1
157: .P
158: .SH TIPS
159: The PHP-FPM CGI daemon will work well with most popular webservers, including Apache2, lighttpd and nginx.
160: .PD 1
161: .P
162: .SH SEE ALSO
163: The PHP-FPM website:
164: .PD 0
165: .P
166: .B http://php-fpm.org
167: .PD 1
168: .P
169: For a more or less complete description of PHP look here:
170: .PD 0
171: .P
172: .B http://www.php.net/manual/
173: .PD 1
174: .P
175: A nice introduction to PHP by Stig Bakken can be found here:
176: .PD 0
177: .P
178: .B http://www.zend.com/zend/art/intro.php
179: .PD 1
180: .SH BUGS
181: You can view the list of known bugs or report any new bug you
182: found at:
183: .PD 0
184: .P
185: .B http://bugs.php.net
186: .PD 1
187: .SH AUTHORS
188: PHP-FPM SAPI was written by Andrei Nigmatulin. The mailing-lists are highload-php-en (English) and highload-php-ru (Russian).
189: .P
190: The PHP Group: Thies C. Arntzen, Stig Bakken, Andi Gutmans, Rasmus Lerdorf, Sam Ruby, Sascha Schumann, Zeev Suraski, Jim Winstead, Andrei Zmievski.
191: .P
192: A List of active developers can be found here:
193: .PD 0
194: .P
195: .B http://www.php.net/credits.php
196: .PD 1
197: .P
198: And last but not least PHP was developed with the help of a huge amount of
199: contributors all around the world.
200: .SH VERSION INFORMATION
201: This manpage describes \fBphp-fpm\fP, version @PHP_VERSION@.
202: .SH COPYRIGHT
203: Copyright \(co 1997\-2009 The PHP Group
204: .PD 0
205: .P
206: Copyright (c) 2007-2009, Andrei Nigmatulin
207: .PD 1
208: .LP
209: This source file is subject to version 3.01 of the PHP license,
210: that is bundled with this package in the file LICENSE, and is
211: available through the world-wide-web at the following url:
212: .PD 0
213: .P
214: .B http://www.php.net/license/3_01.txt
215: .PD 1
216: .P
217: If you did not receive a copy of the PHP license and are unable to
218: obtain it through the world-wide-web, please send a note to
219: .B license@php.net
220: so we can mail you a copy immediately.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>