core.5 (40ca336b7ce7282d18fe017f1f236921e12893d5) core.5 (0dce12b8dd941e12e60126e3a6deeae2f577f80d)
1.\" Copyright (c) 1980, 1991, 1993
2.\" The Regents of the University of California. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.

--- 54 unchanged lines hidden (view full) ---

63.Xr sysctl 8
64variable
65.Va kern.corefile .
66The contents of this variable describes a filename to store
67the core image to.
68This filename can be absolute, or relative (which
69will resolve to the current working directory of the program
70generating it).
1.\" Copyright (c) 1980, 1991, 1993
2.\" The Regents of the University of California. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.

--- 54 unchanged lines hidden (view full) ---

63.Xr sysctl 8
64variable
65.Va kern.corefile .
66The contents of this variable describes a filename to store
67the core image to.
68This filename can be absolute, or relative (which
69will resolve to the current working directory of the program
70generating it).
71Any sequence of
72.Em \&%N
73in this filename template will be replaced by the process name,
74.Em \&%P
75by the processes PID, and
76.Em \&%U
77by the UID.
71.Pp
72The following format specifiers may be used in the
73.Va kern.corefile
74sysctl to insert additional information into the resulting core file
75name:
76.Bl -tag -width "1234567890" -compact -offset "12345"
77.It Em \&%H
78Machine hostname.
79.It Em \&%I
80An index starting at zero until the sysctl
81.Em debug.num_cores
82is reached. This can be useful for limiting the number of corefiles
83generated by a particular process.
84.It Em \&%N
85process name.
86.It Em \&%P
87processes PID.
88.It Em \&%U
89process UID.
90.El
91.Pp
78The name defaults to
79.Em \&%N.core ,
80yielding the traditional
81.Fx
82behaviour.
83.Pp
84By default, a process that changes user or group credentials whether
85real or effective will not create a corefile.
86This behaviour can be
87changed to generate a core dump by setting the
88.Xr sysctl 8
89variable
90.Va kern.sugid_coredump
91to 1.
92The name defaults to
93.Em \&%N.core ,
94yielding the traditional
95.Fx
96behaviour.
97.Pp
98By default, a process that changes user or group credentials whether
99real or effective will not create a corefile.
100This behaviour can be
101changed to generate a core dump by setting the
102.Xr sysctl 8
103variable
104.Va kern.sugid_coredump
105to 1.
106.Pp
107Corefiles can be compressed by the kernel if the following items
108are included in the kernel configuration file:
109.Bl -tag -width "1234567890" -compact -offset "12345"
110.It options
111COMPRESS_USER_CORES
112.It devices
113gzio
114.El
115.Pp
116When COMPRESS_USER_CORES is included the following sysctls can control
117if core files will be compressed:
118.Bl -tag -width "kern.compress_user_cores_gzlevel" -compact -offset "12345"
119.It Em kern.compress_user_cores_gzlevel
120Gzip compression level. Defaults to -1.
121.It Em kern.compress_user_cores
122Actually compress user cores. Core files will have the suffix
123.Em .gz
124appended to them.
125.El
92.Sh EXAMPLES
93In order to store all core images in per-user private areas under
94.Pa /var/coredumps ,
95the following
96.Xr sysctl 8
97command can be used:
98.Pp
99.Dl sysctl kern.corefile="/var/coredumps/\&%U/\&%N.core"
100.Sh SEE ALSO
101.Xr gdb 1 ,
102.Xr kgdb 1 ,
103.Xr setrlimit 2 ,
104.Xr sigaction 2 ,
105.Xr sysctl 8
106.Sh HISTORY
107A
108.Nm
109file format appeared in
110.At v6 .
126.Sh EXAMPLES
127In order to store all core images in per-user private areas under
128.Pa /var/coredumps ,
129the following
130.Xr sysctl 8
131command can be used:
132.Pp
133.Dl sysctl kern.corefile="/var/coredumps/\&%U/\&%N.core"
134.Sh SEE ALSO
135.Xr gdb 1 ,
136.Xr kgdb 1 ,
137.Xr setrlimit 2 ,
138.Xr sigaction 2 ,
139.Xr sysctl 8
140.Sh HISTORY
141A
142.Nm
143file format appeared in
144.At v6 .