summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorNobuyoshi Nakada <nobu@ruby-lang.org>2023-08-10 00:13:22 +0900
committerNobuyoshi Nakada <nobu@ruby-lang.org>2023-09-25 23:22:52 +0900
commit904413997fcc8a14020f01b411d4d8eecd88e670 (patch)
tree202801a6a931a5cb8e8636d47564a020ae20896b /man
parente2a5f0469c7073c2a4d0a6e9a0f493b9967ac984 (diff)
[Feature #19790] [DOC] Fix the manual page as crash report
Also add missing `%f` and `%F`.
Diffstat (limited to 'man')
-rw-r--r--man/ruby.151
1 files changed, 32 insertions, 19 deletions
diff --git a/man/ruby.1 b/man/ruby.1
index eb55b06a4d..a2b69c3cd6 100644
--- a/man/ruby.1
+++ b/man/ruby.1
@@ -472,7 +472,7 @@ If this switch is given, and no script arguments (script file or
options) are present, Ruby quits immediately.
.Pp
.It Fl -crash-report Ns = Ns Ar template
-Sets the template of path name to save bug report.
+Sets the template of path name to save crash report.
See
.Ev RUBY_CRASH_REPORT
environment variable for details.
@@ -652,42 +652,55 @@ Machine stack size used at fiber creation.
default: 262144 or 524288
.Pp
.El
-.Sh BUG REPORT ENVIRONMENT
+.Sh CRASH REPORT ENVIRONMENT
.Pp
.Bl -tag -compact -width "RUBY_CRASH_REPORT"
.It Ev RUBY_CRASH_REPORT
-The template of path name to save bug report.
+The template of path name to save crash report.
default: none
.El
-.Ss Naming bug report files
-The template can contain % specifiers which are substituted
-by the following values when a bug report file is created:
+.Ss Naming crash report files
+The template can contain
+.Li \fB%\fP
+specifiers which are substituted by the following values when a crash
+report file is created:
.Pp
.Bl -hang -compact -width "%NNN"
-.It %%
-A single % character.
-.It %e
+.It Li \fB%%\fP
+A single
+.Li \fB%\fP
+character.
+.It Li \fB%e\fP
Basename of executable.
-.It %E
+.It Li \fB%E\fP
Pathname of executable,
with slashes (\fB/\fP) replaced by exclamation marks (\fB!\fP).
-.It %p
+.It Li \fB%f\fP
+Basename of the program name,
+.Li "$0" .
+.It Li \fB%F\fP
+Pathname of the program name,
+.Li "$0",
+with slashes (\fB/\fP) replaced by exclamation marks (\fB!\fP).
+.It Li \fB%p\fP
PID of dumped process.
-.It %t
+.It Li \fB%t\fP
Time of dump, expressed as seconds since the
Epoch, 1970-01-01 00:00:00 +0000 (UTC).
-.It %NNN
+.It Li \fB%NNN\fP
A character code in octal.
.El
.Pp
-A single % at the end of the template is dropped from the
-core filename, as is the combination of a % followed by any
-character other than those listed above.
-All other characters in the template become a literal
-part of the core filename.
+A single
+.Li \fB%\fP
+at the end of the template is dropped from the core filename, as is
+the combination of a
+.Li \fB%\fP
+followed by any character other than those listed above. All other
+characters in the template become a literal part of the core filename.
The template may include \(aq/\(aq characters, which are interpreted
as delimiters for directory names.
-.Ss Piping bug reports to a program
+.Ss Piping crash reports to a program
If the first character of this file is a pipe symbol (\fB|\fP),
then the remainder of the line is interpreted as the command-line for
a program (or script) that is to be executed.