projects / systemd.git / blame
| Commit | Line | Data |
|---|---|---|
| e842803a | 1 | '\" t |
| 5eef597e | 2 | .TH "COREDUMP\&.CONF" "5" "" "systemd 217" "coredump.conf" |
| e842803a MB |
3 | .\" ----------------------------------------------------------------- |
| 4 | .\" * Define some portability stuff | |
| 5 | .\" ----------------------------------------------------------------- | |
| 6 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 7 | .\" http://bugs.debian.org/507673 | |
| 8 | .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html | |
| 9 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 10 | .ie \n(.g .ds Aq \(aq | |
| 11 | .el .ds Aq ' | |
| 12 | .\" ----------------------------------------------------------------- | |
| 13 | .\" * set default formatting | |
| 14 | .\" ----------------------------------------------------------------- | |
| 15 | .\" disable hyphenation | |
| 16 | .nh | |
| 17 | .\" disable justification (adjust text to left margin only) | |
| 18 | .ad l | |
| 19 | .\" ----------------------------------------------------------------- | |
| 20 | .\" * MAIN CONTENT STARTS HERE * | |
| 21 | .\" ----------------------------------------------------------------- | |
| 22 | .SH "NAME" | |
| 23 | coredump.conf \- Coredump storage configuration file | |
| 24 | .SH "SYNOPSIS" | |
| 25 | .PP | |
| 26 | /etc/systemd/coredump\&.conf | |
| 27 | .SH "DESCRIPTION" | |
| 28 | .PP | |
| 29 | This file configures the behaviour of | |
| 30 | \fBsystemd\-coredump\fR, a handler for core dumps invoked by the kernel\&. | |
| 31 | .SH "OPTIONS" | |
| 32 | .PP | |
| 33 | All options are configured in the | |
| 34 | "[Coredump]" | |
| 35 | section: | |
| 36 | .PP | |
| 37 | \fIStorage=\fR | |
| 38 | .RS 4 | |
| 39 | Controls where to store cores\&. One of | |
| 40 | "none", | |
| 41 | "external", | |
| 42 | "journal", and | |
| 43 | "both"\&. When | |
| 44 | "none", the coredumps will be logged but not stored permanently\&. When | |
| 45 | "external" | |
| 46 | (the default), cores will be stored in | |
| 47 | /var/lib/systemd/coredump\&. When | |
| 48 | "journal", cores will be stored in the journal and rotated following normal journal rotation patterns\&. When | |
| 49 | "both", cores will be stored in both locations\&. | |
| 50 | .sp | |
| 51 | When cores are stored in the journal, they might be compressed following journal compression settings, see | |
| 52 | \fBjournald.conf\fR(5)\&. When cores are stored externally, they will be compressed by default, see below\&. | |
| 53 | .RE | |
| 54 | .PP | |
| 55 | \fICompress=\fR | |
| 56 | .RS 4 | |
| 57 | Controls the type of compression for external storage\&. Takes a boolean argument, defaults to | |
| 58 | "yes"\&. | |
| 59 | .RE | |
| 60 | .PP | |
| 61 | \fIProcessSizeMax=\fR | |
| 62 | .RS 4 | |
| 63 | The maximum size in bytes of a core which will be processed\&. Coredumps exceeding this size will be logged, but the backtrace will not be generated and the core will not be stored\&. | |
| 64 | .RE | |
| 65 | .PP | |
| 66 | \fIExternalSizeMax=\fR, \fIJournalSizeMax=\fR | |
| 67 | .RS 4 | |
| 68 | The maximum (uncompressed) size in bytes of a core to be saved\&. | |
| 69 | .RE | |
| 70 | .PP | |
| 71 | \fIMaxUse=\fR, \fIKeepFree=\fR | |
| 72 | .RS 4 | |
| 73 | Enforce limits on the disk space taken up by externally stored coredumps\&. | |
| 74 | \fBMaxUse=\fR | |
| 75 | makes sure that old coredumps are removed as soon as the total disk space taken up by coredumps grows beyond this limit (defaults to 10% of the total disk size)\&. | |
| 76 | \fBKeepFree=\fR | |
| 5eef597e | 77 | controls how much disk space to keep free at least (defaults to 15% of the total disk size)\&. Note that the disk space used by coredumps might temporarily exceed these limits while coredumps are processed\&. Note that old coredumps are also removed based on time via |
| e842803a MB |
78 | \fBsystemd-tmpfiles\fR(8)\&. |
| 79 | .RE | |
| 80 | .SH "SEE ALSO" | |
| 81 | .PP | |
| 82 | \fBsystemd-journald.service\fR(8), | |
| 83 | \fBcoredumpctl\fR(1), | |
| 84 | \fBsystemd-tmpfiles\fR(8) |