add Cli\Args\Help
[pharext/pharext] / README.md
1 # pharext
2
3 Distribute your PHP extension as self-installable phar executable
4
5 ## About
6
7 You don't need this package to install any `*.ext.phar` extension packages,
8 just run them with php:
9
10 $ ./pecl_http-2.4.2.ext.phar
11
12 For a compressed phar, or if the execute permission bit got lost somehow:
13
14 $ php pecl_http-2.4.2.ext.phar.gz
15
16 Command help:
17
18 $ ./pecl_http-2.4.2.ext.phar -h
19
20 Yields:
21
22 pharext v3.0.0 (c) Michael Wallner <mike@php.net>
23
24 Usage:
25
26 $ ./pecl_http-2.4.2.ext.phar [-hvqs] [-p|-n|-c|-i <arg>]
27
28 -h|--help Display help
29 -v|--verbose More output
30 -q|--quiet Less output
31 -p|--prefix <arg> PHP installation prefix if phpize is not in $PATH, e.g. /opt/php7
32 -n|--common-name <arg> PHP common program name, e.g. php5 or zts-php [php]
33 -c|--configure <arg> Additional extension configure flags, e.g. -c --with-flag
34 -s|--sudo [<arg>] Installation might need increased privileges [sudo -S %s]
35 -i|--ini <arg> Activate in this php.ini instead of loaded default php.ini
36 --signature Show package signature
37 --license Show package license
38 --name Show package name
39 --date Show package release date
40 --release Show package release version
41 --version Show pharext version
42 --enable-propro [<arg>] Whether to enable property proxy support [yes]
43 --enable-raphf [<arg>] Whether to enable raphf support [yes]
44 --with-http-zlib-dir [<arg>] Where to find zlib [/usr]
45 --with-http-libcurl-dir [<arg>] Where to find libcurl [/usr]
46 --with-http-libevent-dir [<arg>] Where to find libevent [/usr]
47
48
49 If your installation destination needs escalated permissions, have a look at [the `--sudo` option](https://github.com/m6w6/pharext/wiki/Usage-of-*.ext.phar-packages#privileges):
50
51 Installing propro-1.0.1.ext.phar ...
52 Running phpize ...
53 Running configure ...
54 Running make ...
55 Running make install ...
56 Running INI activation ...
57 Extension already activated ...
58 Successfully installed propro-1.0.1.ext.phar!
59 Installing raphf-1.0.5.ext.phar ...
60 Running phpize ...
61 Running configure ...
62 Running make ...
63 Running make install ...
64 Running INI activation ...
65 Extension already activated ...
66 Successfully installed raphf-1.0.5.ext.phar!
67 Installing pecl_http-2.4.2.ext.phar ...
68 Running phpize ...
69 Running configure ...
70 Running make ...
71 Running make install ...
72 Running INI activation ...
73 Extension already activated ...
74 Successfully installed pecl_http-2.4.2.ext.phar!
75
76
77 ### Prerequisites
78
79 The usual tools you need to build a PHP extension:
80 * php, phpize and php-config
81 * make, cc and autotools
82
83 A network connection is not needed.
84
85 ## Extension maintainers
86
87 Download the pharext binary of the [latest release](https://github.com/m6w6/pharext/releases/latest).
88
89 Be aware that you need the [public key](https://github.com/m6w6/pharext/wiki/Public-key) to run official `pharext` releases.
90
91 -----BEGIN PUBLIC KEY-----
92 MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5x9bwisjDBDV/bwDiju2
93 Ebx4kPir32WwT3+hxV0/qAPclA1WsrpcUJ7BChk+Rlz8ujOcyENTidgI1vj3oUpo
94 /P9XlLQOSrJHYz+AOg7qwhTe89xIJspS4gHHiXUAmxz0TyCNMbOyrLcjP5CmZdll
95 n+e3HP8Kfipr4XyWBhsKbdYUZ8Ga6IeFMYzNqCzWazcOasdCpsablmyrfCaZoJ0l
96 bFald0nF3/YoeYgo3fWb4Md9Xf/grpz8Ocqyq4OY49Vb0/p8FMwzBV6vbVh/eAV/
97 jrP7L40Jw97nSBrP/5nK8Ylc5BayVRq/HhT3kLMC//zvPjb8xz3ZgVTQrwWTF3Zy
98 +wIDAQAB
99 -----END PUBLIC KEY-----
100
101 Place it as `pharext.pubkey` in the same directory where the `pharext` binary is located. IF you cloned the repository or installed `pharext` through composer, it is already at the right location.
102
103 Please have a look at the [wiki](https://github.com/m6w6/pharext/wiki), to learn [how to use](https://github.com/m6w6/pharext/wiki/Usage-of-the-pharext-packager) the pharext installer to package self-installing PHP extensions.
104