Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add manpages for bootchart2, bootchartd and pybootchartgui
Contributed by Francesca Ciceri and David Paleino.
- Loading branch information
Showing
5 changed files
with
198 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
.TH BOOTCHART2 1 2011-03-07 | ||
.SH NAME | ||
bootchart2 \- collects and analyses data from boot process | ||
.SH DESCRIPTION | ||
bootchart2 is a tool to log the boot process and make a nice | ||
graph out of it, to usually see where it takes longer. | ||
.br | ||
It consists of three different pieces of software: | ||
a shell script, a collector and a visualisation tool. | ||
.br | ||
Please also see the manual pages referred to in the \fBSEE ALSO\fR | ||
section. | ||
.SH CONFIGURATION | ||
After install simply add these options to your kernel command line, normally in \fI/boot/grub/menu.lst: | ||
.in +4n | ||
.nf | ||
|
||
.B "initcall_debug printk.time=y quiet init=/sbin/bootchartd ..." | ||
|
||
.fi | ||
.in | ||
Then after bootup run pybootchartgui to get an interactive | ||
chart rendering tool. | ||
If you want to chart the initrd, add | ||
.in +4n | ||
.nf | ||
|
||
.B rdinitrd=/sbin/bootchartd | ||
|
||
.fi | ||
.in | ||
to the kernel command line. | ||
.PP | ||
To make bootchart2 work best, please ensure your kernel is | ||
configured with | ||
.I CONFIG_PROC_EVENTS=y | ||
and | ||
.I CONFIG_TASKSTATS=y | ||
. | ||
.PP | ||
If you want to start bootchart2 in a dracut (version >= 008) | ||
initramfs, you have to change | ||
.I init=/sbin/bootchartd | ||
to | ||
.I rdinit=/sbin/bootchartd | ||
and regenerate the initramfs with bootchart support with: | ||
.in +4n | ||
.nf | ||
|
||
.B "# dracut -f -a bootchart" | ||
|
||
.fi | ||
.in | ||
.SH SEE ALSO | ||
.BR pybootchartgui (1), | ||
.BR bootchartd (1) | ||
.SH AUTHOR | ||
\fBbootchart2\fR was written by: | ||
.in +4n | ||
.nf | ||
|
||
Anders Norgaard <anders.norgaard@gmail.com> | ||
Michael Meeks <michael.meeks@novell.com> | ||
Scott James Remnant <scott@ubuntu.com> | ||
Henning Niss <henningniss@gmail.com> | ||
Riccardo Magliocchetti <riccardo.magliocchetti@gmail.com> | ||
|
||
.fi | ||
.in | ||
.PP | ||
This manual page was written by Francesca Ciceri <madamezou@yahoo.it>, | ||
for the Debian project (and may be used by others), and is licensed | ||
under the GNU General Public License, version 2 or, at your choice, any | ||
later version. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
.TH BOOTCHARTD 1 2011-02-25 | ||
.SH NAME | ||
bootchartd \- collects and analyses data from boot process | ||
.SH SYNOPSIS | ||
.B bootchartd | ||
[\fBstart\fR|\fBstop\fR] | ||
.SH DESCRIPTION | ||
\fBbootchartd\fR is a daemon collecting data from boot process. | ||
.br | ||
Please see \fBbootchart2 (1)\fR for more information. | ||
.SH OPTIONS | ||
.TP | ||
.B start | ||
Start the daemon. | ||
.TP | ||
.B stop | ||
Stop the daemon | ||
.SH FILES | ||
.TP | ||
.I /etc/bootchartd.conf | ||
.TP | ||
.I /sbin/bootchartd | ||
.SH SEE ALSO | ||
.BR bootchart2 (1), | ||
.BR bootchartd (1) | ||
.SH AUTHOR | ||
\fBbootchart2\fR was written by: | ||
.in +4n | ||
.nf | ||
|
||
Anders Norgaard <anders.norgaard@gmail.com> | ||
Michael Meeks <michael.meeks@novell.com> | ||
Scott James Remnant <scott@ubuntu.com> | ||
Henning Niss <henningniss@gmail.com> | ||
Riccardo Magliocchetti <riccardo.magliocchetti@gmail.com> | ||
|
||
.fi | ||
.in | ||
.PP | ||
This manual page was written by Francesca Ciceri <madamezou@yahoo.it>, | ||
for the Debian project (and may be used by others), and is licensed | ||
under the GNU General Public License, version 2 or, at your choice, any | ||
later version. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
.TH PYBOOTCHARTGUI 1 "September 19, 2010" | ||
.SH NAME | ||
pybootchartgui \- viewer for boot process performance analysis results | ||
.SH SYNOPSIS | ||
.B pybootchartgui | ||
.RI [ options ] " files" ... | ||
.SH DESCRIPTION | ||
This manual page documents briefly the \fBpybootchartgui\fR command. | ||
.PP | ||
\fBpybootchartgui\fP is a graphical program to view the data recorded by | ||
\fBbootchart2\fP. | ||
.SH OPTIONS | ||
.TP | ||
.B \-h, \-\-help | ||
Show summary of options.t | ||
.TP | ||
.B \-\-version | ||
Show version of program. | ||
.TP | ||
.B \-i, \-\-interactive | ||
Start in active mode | ||
.TP | ||
\fB\-f\fR \fIFORMAT\fR, \fB\-\-format=\fIFORMAT\fR | ||
Image format | ||
.TP | ||
\fB\-o\fR \fIPATH\fR, \fB\-\-output=\fIPATH\fR | ||
Output path (file or directory) where charts are stored | ||
.TP | ||
.B \-n, \-\-no\-prune | ||
Do not prune the process tree | ||
.TP | ||
.B \-q, \-\-quiet | ||
Suppress informational messages | ||
.TP | ||
.B \-t, \-\-boot\-time | ||
Only display the boot time of the boot in text format (stdout) | ||
.TP | ||
.B \-\-very\-quiet | ||
Suppress all messages except errors | ||
.TP | ||
.B \-\-verbose | ||
Print all messages | ||
.TP | ||
.B \-\-profile | ||
Profile rendering of chart (only useful when in batch mode indicated by \fB-f\fR) | ||
.TP | ||
.B \-\-show\-pid | ||
Show process ids in the bootchart as '\fIprocessname [pid]\fR' | ||
.TP | ||
.B \-\-show\-all | ||
Show all process information in the bootchart as '\fI/process/path/exe [pid] [args]\fR' | ||
.TP | ||
\fB\-\-crop\-after=\fIPROCESS\fR | ||
Crop chart when idle after \fIPROCESS\fR is started | ||
.TP | ||
\fB\-\-annotate=\fIPROCESS\fR | ||
Annotate position where \fIPROCESS\fR is started; can be specified multiple | ||
times. To create a single annotation when any one of a set of processes is | ||
started, use commas to separate the names. | ||
.TP | ||
\fB\-\-annotate\-file=\fIFILENAME\fR | ||
Filename to write annotation points to. | ||
.SH SEE ALSO | ||
.BR bootchart2 (1), | ||
.BR bootchartd (1) | ||
.SH AUTHOR | ||
\fBpybootchartgui\fR is part of the \fBbootchart2\fR suite. | ||
.PP | ||
\fBbootchart2\fR was written by Michael Meeks <michael.meeks@novell.com>, | ||
Anders Norgaard <anders.norgaard@gmail.com>, Scott James Remnant <scott@ubuntu.com> | ||
and Henning Niss <henningniss@gmail.com>. | ||
.PP | ||
This manual page was written by David Paleino <dapal@debian.org>, | ||
for the Debian project (and may be used by others), and is licensed | ||
under the same terms of \fBbootchart2\fR. |