manpage updates
PATCH 1/1 manpage updates
I have been working with xen and it's monitoring facilities lately but have found a number of shortcomings with the associated documentation. I hope the attached patch remedies this.
--Kaleb
xentrace.8 renamed from usr/share/man/man8/xentrace.8 +75 -0
@@ -33,10 +33,85 @@ all new records to the output .TP .B -s, --poll-sleep=p set the time, p, (in milliseconds) to sleep between polling the buffers for new data. +.TP +.B -c, --cpu-mask=c +set cpu-mask +.TP +.B -e, --evt-mask=e +set evt-mask +.TP +.B -?, --help +Give this help list +.TP +.B --usage +Give a short usage message +.TP +.B -V, --version +Print program version + +.SS Event Classes (Masks) +The following event classes (masks) can be used to filter the events being +gathered by xentrace: +.PP + \fIID\fP \fIDescription\fP +.PP + 0x0001f000 TRC_GEN + 0x0002f000 TRC_SCHED + 0x0004f000 TRC_DOM0OP + 0x0008f000 TRC_VMX + 0x000af000 TRC_MEM + 0xfffff000 TRC_ALL + + +.SS Event Subclasses (More Masks) +The following event subclasses (masks) can also be used to filter the events being +gathered by xentrace: +.PP + \fIID\fP \fIDescription\fP +.PP + 0x00081000 TRC_VMXEXIT + 0x00082000 TRC_VMXTIMER + 0x00084000 TRC_VMXINT + 0x00088000 TRC_VMXIO + + +.SS Events +.B xentrace +collects the following events from the trace buffer: +.PP + \fIID\fP \fIDescription\fP +.PP + 0x0002f001 TRC_SCHED_DOM_ADD + 0x0002f002 TRC_SCHED_DOM_REM + 0x0002f003 TRC_SCHED_SLEEP + 0x0002f004 TRC_SCHED_WAKE + 0x0002f005 TRC_SCHED_YIELD + 0x0002f006 TRC_SCHED_BLOCK + 0x0002f007 TRC_SCHED_SHUTDOWN + 0x0002f008 TRC_SCHED_CTL + 0x0002f009 TRC_SCHED_ADJDOM + 0x0002f010 TRC_SCHED_SWITCH + 0x0002f011 TRC_SCHED_S_TIMER_FN + 0x0002f012 TRC_SCHED_T_TIMER_FN + 0x0002f013 TRC_SCHED_DOM_TIMER_FN + 0x0002f014 TRC_SCHED_SWITCH_INFPREV + 0x0002f015 TRC_SCHED_SWITCH_INFNEXT + + 0x000af001 TRC_MEM_PAGE_GRANT_MAP + 0x000af002 TRC_MEM_PAGE_GRANT_UNMAP + 0x000af003 TRC_MEM_PAGE_GRANT_TRANSFER + + 0x00081001 TRC_VMX_VMEXIT + 0x00081002 TRC_VMX_VMENTRY + + 0x00082001 TRC_VMX_TIMER_INTR + + 0x00084001 TRC_VMX_INT +.PP .SH AUTHOR Mark A. Williamson <[email protected]> .SH "SEE ALSO"
.TH TBCTL 8 "11 March 2004" "Xen domain 0 utils"
.SH NAME
tbctl \- set size of trace buffer
.SH SYNOPSIS
.B tbctl
.I FLAG
.SH DESCRIPTION
.B tbctl
is used to turn on and off the trace buffer.
.I NOTE:
A size must be set on the trace buffer using
.I setsize(8)
before the trace buffer can be turned on.
.I FLAG
should be either 0 or 1 where 0 turns the trace buffer off and 1 turns the trace buffer on.
.SH "SEE ALSO"xentrace_cpuinfo(1), xentrace_format(1), setsize(8)
.TH SETSIZE 8 "11 March 2004" "Xen domain 0 utils" .SH NAME
setsize \- set size of trace buffer
.SH SYNOPSIS
.B setsize
.I SIZE
.SH DESCRIPTION
.B setsize
is used to set the number of pages that should be allocated for the trace buffer.
.I FILE
is an integer greater than or equal to zero. 10 and 20 are reasonable examples.
.SH "SEE ALSO"xentrace_cpuinfo(1), xentrace_format(1), tbctl(8)
_______________________________________________
Xen-devel mailing list
[email protected]
http://lists.xensource.com/xen-devel