php-fpm.8.in 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233
  1. .TH PHP-FPM 8 "2021" "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 \-\-pid \fIfile\fP
  88. .TP
  89. .PD 1
  90. .B \-g
  91. Specify the PID file location.
  92. .TP
  93. .PD 0
  94. .B \-\-fpm\-config \fIfile\fP
  95. .TP
  96. .PD 1
  97. .B \-y
  98. Specify alternative path to FastCGI process manager configuration file (the default is @php_fpm_sysconfdir@/php-fpm.conf)
  99. .TP
  100. .PD 0
  101. .B \-\-test
  102. .TP
  103. .PD 1
  104. .B \-t
  105. Test FPM configuration file and exit
  106. If called twice (\-tt), the configuration is dumped before exiting.
  107. .TP
  108. .PD 0
  109. .B \-\-daemonize
  110. .TP
  111. .PD 1
  112. .B \-D
  113. Force to run in background and ignore daemonize option from configuration file.
  114. .TP
  115. .PD 0
  116. .B \-\-nodaemonize
  117. .TP
  118. .PD 1
  119. .B \-F
  120. Force to stay in foreground and ignore daemonize option from configuration file.
  121. .TP
  122. .PD 0
  123. .B \-\-force-stderr
  124. .TP
  125. .PD 1
  126. .B \-O
  127. Force output to stderr in nodaemonize even if stderr is not a TTY.
  128. .TP
  129. .PD 0
  130. .B \-\-allow\-to\-run\-as\-root
  131. .TP
  132. .PD 1
  133. .B \-R
  134. Allow pool to run as root (disabled by default)
  135. .SH FILES
  136. .TP 15
  137. .B php-fpm.conf
  138. The configuration file for the php-fpm daemon.
  139. .TP
  140. .B php.ini
  141. The standard php configuration file.
  142. .SH EXAMPLES
  143. 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.
  144. .P
  145. .PD 1
  146. .RS
  147. sudo /etc/init.d/php-fpm start
  148. .RE
  149. .TP
  150. 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.
  151. .P
  152. .PD 1
  153. .RS
  154. sudo systemctl start php-fpm.service
  155. .RE
  156. .TP
  157. 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:
  158. .P
  159. .PD 0
  160. .RS
  161. .B SIGINT,SIGTERM \fPimmediate termination
  162. .TP
  163. .B SIGQUIT \fPgraceful stop
  164. .TP
  165. .B SIGUSR1 \fPre-open log file
  166. .TP
  167. .B SIGUSR2 \fPgraceful reload of all workers + reload of fpm conf/binary
  168. .RE
  169. .PD 1
  170. .P
  171. .SH TIPS
  172. The PHP-FPM CGI daemon will work well with most popular webservers, including Apache2, lighttpd and nginx.
  173. .PD 1
  174. .P
  175. .SH SEE ALSO
  176. The PHP-FPM website:
  177. .PD 0
  178. .P
  179. .B http://php-fpm.org
  180. .PD 1
  181. .P
  182. For a more or less complete description of PHP look here:
  183. .PD 0
  184. .P
  185. .B http://www.php.net/manual/
  186. .PD 1
  187. .P
  188. A nice introduction to PHP by Stig Bakken can be found here:
  189. .PD 0
  190. .P
  191. .B http://www.zend.com/zend/art/intro.php
  192. .PD 1
  193. .SH BUGS
  194. You can view the list of known bugs or report any new bug you
  195. found at:
  196. .PD 0
  197. .P
  198. .B http://bugs.php.net
  199. .PD 1
  200. .SH AUTHORS
  201. PHP-FPM SAPI was written by Andrei Nigmatulin. The mailing-lists are highload-php-en (English) and highload-php-ru (Russian).
  202. .P
  203. The PHP Group: Thies C. Arntzen, Stig Bakken, Andi Gutmans, Rasmus Lerdorf, Sam Ruby, Sascha Schumann, Zeev Suraski, Jim Winstead, Andrei Zmievski.
  204. .P
  205. A List of active developers can be found here:
  206. .PD 0
  207. .P
  208. .B http://www.php.net/credits.php
  209. .PD 1
  210. .P
  211. And last but not least PHP was developed with the help of a huge amount of
  212. contributors all around the world.
  213. .SH VERSION INFORMATION
  214. This manpage describes \fBphp-fpm\fP, version @PHP_VERSION@.
  215. .SH COPYRIGHT
  216. Copyright \(co The PHP Group
  217. .PD 0
  218. .P
  219. Copyright (c) 2007-2009, Andrei Nigmatulin
  220. .PD 1
  221. .LP
  222. This source file is subject to version 3.01 of the PHP license,
  223. that is bundled with this package in the file LICENSE, and is
  224. available through the world-wide-web at the following url:
  225. .PD 0
  226. .P
  227. .B https://www.php.net/license/3_01.txt
  228. .PD 1
  229. .P
  230. If you did not receive a copy of the PHP license and are unable to
  231. obtain it through the world-wide-web, please send a note to
  232. .B license@php.net
  233. so we can mail you a copy immediately.