Skip to content

Commit 91996e7

Browse files
kabelpetk
authored andcommitted
Fix bug 76595: Update phpdbg man page
Send phpdbg.1 man page through configure replacements Update phpdbg.1 man page to include all options Fixes formatting to be more consistent with php.1 Fix paragraph whitespace and ignore phpdbg.1
1 parent 41c6976 commit 91996e7

File tree

5 files changed

+157
-63
lines changed

5 files changed

+157
-63
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,7 @@ sapi/fpm/fpm/php-cgi
274274
sapi/phpdbg/phpdbg_parser.c
275275
sapi/phpdbg/phpdbg_parser.h
276276
sapi/phpdbg/phpdbg
277+
sapi/phpdbg/phpdbg.1
277278
scripts/php-config
278279
scripts/phpize
279280
scripts/man1/*.1

Makefile.global

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ distclean: clean
121121
rm -f Makefile config.cache config.log config.status Makefile.objects Makefile.fragments libtool main/php_config.h main/internal_functions_cli.c main/internal_functions.c stamp-h buildmk.stamp Zend/zend_dtrace_gen.h Zend/zend_dtrace_gen.h.bak Zend/zend_config.h TSRM/tsrm_config.h
122122
rm -f php7.spec main/build-defs.h scripts/phpize
123123
rm -f ext/date/lib/timelib_config.h ext/mbstring/oniguruma/config.h ext/mbstring/libmbfl/config.h ext/oci8/oci8_dtrace_gen.h ext/oci8/oci8_dtrace_gen.h.bak
124-
rm -f scripts/man1/phpize.1 scripts/php-config scripts/man1/php-config.1 sapi/cli/php.1 sapi/cgi/php-cgi.1 ext/phar/phar.1 ext/phar/phar.phar.1
124+
rm -f scripts/man1/phpize.1 scripts/php-config scripts/man1/php-config.1 sapi/cli/php.1 sapi/cgi/php-cgi.1 sapi/phpdbg/phpdbg.1 ext/phar/phar.1 ext/phar/phar.phar.1
125125
rm -f sapi/fpm/php-fpm.conf sapi/fpm/init.d.php-fpm sapi/fpm/php-fpm.service sapi/fpm/php-fpm.8 sapi/fpm/status.html
126126
rm -f ext/iconv/php_have_bsd_iconv.h ext/iconv/php_have_glibc_iconv.h ext/iconv/php_have_ibm_iconv.h ext/iconv/php_have_iconv.h ext/iconv/php_have_libiconv.h ext/iconv/php_iconv_aliased_libiconv.h ext/iconv/php_iconv_supports_errno.h ext/iconv/php_php_iconv_h_path.h ext/iconv/php_php_iconv_impl.h
127127
rm -f ext/phar/phar.phar ext/phar/phar.php

sapi/phpdbg/config.m4

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,17 @@ if test "$BUILD_PHPDBG" = "" && test "$PHP_PHPDBG" != "no"; then
2727
if test "$PHP_READLINE" != "no" -o "$PHP_LIBEDIT" != "no"; then
2828
PHPDBG_EXTRA_LIBS="$PHP_READLINE_LIBS"
2929
fi
30-
30+
3131
PHP_SUBST(PHP_PHPDBG_CFLAGS)
3232
PHP_SUBST(PHP_PHPDBG_FILES)
3333
PHP_SUBST(PHPDBG_EXTRA_LIBS)
34-
34+
3535
PHP_ADD_MAKEFILE_FRAGMENT([$abs_srcdir/sapi/phpdbg/Makefile.frag], [$abs_srcdir/sapi/phpdbg], [$abs_builddir/sapi/phpdbg])
3636
PHP_SELECT_SAPI(phpdbg, program, $PHP_PHPDBG_FILES, $PHP_PHPDBG_CFLAGS, [$(SAPI_PHPDBG_PATH)])
3737

3838
BUILD_BINARY="sapi/phpdbg/phpdbg"
3939
BUILD_SHARED="sapi/phpdbg/libphpdbg.la"
40-
40+
4141
BUILD_PHPDBG="\$(LIBTOOL) --mode=link \
4242
\$(CC) -export-dynamic \$(CFLAGS_CLEAN) \$(EXTRA_CFLAGS) \$(EXTRA_LDFLAGS_PROGRAM) \$(LDFLAGS) \$(PHP_RPATHS) \
4343
\$(PHP_GLOBAL_OBJS) \
@@ -63,6 +63,8 @@ if test "$BUILD_PHPDBG" = "" && test "$PHP_PHPDBG" != "no"; then
6363
PHP_SUBST(BUILD_SHARED)
6464
PHP_SUBST(BUILD_PHPDBG)
6565
PHP_SUBST(BUILD_PHPDBG_SHARED)
66+
67+
PHP_OUTPUT(sapi/phpdbg/phpdbg.1)
6668
fi
6769

6870
if test "$PHP_PHPDBG_WEBHELPER" != "no"; then

sapi/phpdbg/phpdbg.1

Lines changed: 0 additions & 59 deletions
This file was deleted.

sapi/phpdbg/phpdbg.1.in

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
.TH @program_prefix@phpdbg 1 "2018" "The PHP Group" "Scripting Language"
2+
.SH NAME
3+
@program_prefix@phpdbg \- The interactive PHP debugger
4+
.SH SYNOPSIS
5+
.B @program_prefix@phpdbg
6+
[options]
7+
[\fIfile\fP]
8+
[\fIargs...\fP]
9+
.SH DESCRIPTION
10+
.B phpdbg
11+
is a lightweight, powerful, easy to use debugging platform for PHP.
12+
.SH OPTIONS
13+
.TP 15
14+
.B \-c \fIpath\fB|\fIfile\fR
15+
Look for
16+
.B php.ini
17+
file in the directory
18+
.IR path
19+
or use the specified
20+
.IR file
21+
.TP
22+
.B \-d \fIfoo\fP[=\fIbar\fP]
23+
Define INI entry
24+
.IR foo
25+
with value
26+
.IR bar
27+
.TP
28+
.B \-n
29+
No
30+
.B php.ini
31+
file will be used
32+
.TP
33+
.B \-z \fIfile\fR
34+
Load Zend extension
35+
.IR file
36+
.TP
37+
.BR \-q
38+
Do not print banner on startup
39+
.TP
40+
.B \-v
41+
Enable oplog output
42+
.TP
43+
.B \-b
44+
Disables use of color on the console
45+
.TP
46+
.B \-i \fIpath\fB|\fIfile\fR
47+
Override .phpgdbinit location (implies -I)
48+
.TP
49+
.B \-I
50+
Ignore .phpdbginit (default init file)
51+
.TP
52+
.B \-O \fIfile\fR
53+
Set oplog output to
54+
.IR file
55+
.TP
56+
.B \-r
57+
Jump straight to run
58+
.TP
59+
.B -e
60+
Generate extended information for debugger/profiler
61+
.TP
62+
.B \-E
63+
Enable step through eval()
64+
.TP
65+
.B \-s \fIdelimiter\fP
66+
Read code to execute from stdin with an optional
67+
.IR delimiter
68+
.TP
69+
.B \-S \fIsapi_name\fP
70+
Override SAPI name
71+
.TP
72+
.B \-l \fIport\fP
73+
Setup remote console port
74+
.TP
75+
.B \-a \fIaddress\fP
76+
Setup remote console bind address
77+
.TP
78+
.B \-x
79+
Enable XML output
80+
.TP
81+
.B \-p \fIopcode\fP
82+
Output opcodes and quit
83+
.TP
84+
.B \-h
85+
Print the help overview
86+
.TP
87+
.B \-V
88+
Version number
89+
.TP
90+
.IR args.\|.\|.
91+
Arguments passed to script. Use
92+
.B '\-\-'
93+
.IR args
94+
when first argument starts with
95+
.B '\-'
96+
or script is read from stdin
97+
.SH NOTES
98+
Passing
99+
.B \-rr
100+
will cause
101+
.B phpdbg
102+
to quit after execution, rather than returning to the console
103+
.SH FILES
104+
.TP 15
105+
.B php.ini
106+
The standard configuration file
107+
.TP
108+
.B .phpdbginit
109+
The init file
110+
.SH SEE ALSO
111+
The online manual can be found at
112+
.PD 0
113+
.P
114+
.B http://php.net/manual/book.phpdbg.php
115+
.PD 1
116+
.SH BUGS
117+
You can view the list of known bugs or report any new bug you
118+
found at
119+
.PD 0
120+
.P
121+
.B http://bugs.php.net/
122+
.PD 1
123+
.SH AUTHORS
124+
Written by Felipe Pena, Joe Watkins and Bob Weinand, formatted by Ondřej Surý for Debian project.
125+
.P
126+
A List of active developers can be found at
127+
.PD 0
128+
.P
129+
.B http://www.php.net/credits.php
130+
.PD 1
131+
.P
132+
And last but not least PHP was developed with the help of a huge amount of
133+
contributors all around the world.
134+
.SH VERSION INFORMATION
135+
This manpage describes \fBphpdbg\fP, for PHP version @PHP_VERSION@.
136+
.SH COPYRIGHT
137+
Copyright \(co 1997\-2018 The PHP Group
138+
.LP
139+
This source file is subject to version 3.01 of the PHP license,
140+
that is bundled with this package in the file LICENSE, and is
141+
available through the world-wide-web at the following url:
142+
.PD 0
143+
.P
144+
.B http://www.php.net/license/3_01.txt
145+
.PD 1
146+
.P
147+
If you did not receive a copy of the PHP license and are unable to
148+
obtain it through the world-wide-web, please send a note to
149+
.B license@php.net
150+
so we can mail you a copy immediately.

0 commit comments

Comments
 (0)