Add manpages for all installed binaries.

This commit is contained in:
Eric Anholt 2009-05-19 16:09:08 -07:00
parent 49cba961a2
commit e71c628302
10 changed files with 137 additions and 1 deletions

View File

@ -22,7 +22,7 @@
AUTOMAKE_OPTIONS = foreign
ACLOCAL_AMFLAGS = -I m4
SUBDIRS = lib tests tools benchmarks
SUBDIRS = lib man tests tools benchmarks
DISTCLEANFILES = \
doltcompile \
doltlibtool

View File

@ -67,6 +67,7 @@ AC_OUTPUT([
Makefile
benchmarks/Makefile
lib/Makefile
man/Makefile
tests/Makefile
tools/Makefile
])

8
man/Makefile.am Normal file
View File

@ -0,0 +1,8 @@
dist_man1_MANS = \
intel_gpu_dump.1 \
intel_gpu_top.1 \
intel_stepping.1 \
intel_upload_blit_large.1 \
intel_upload_blit_large_gtt.1 \
intel_upload_blit_large_map.1 \
intel_upload_blit_small.1

22
man/intel_gpu_dump.1 Normal file
View File

@ -0,0 +1,22 @@
.\" shorthand for double quote that works everywhere.
.ds q \N'34'
.TH intel_gpu_dump 1 "intel_gpu_dump 1.0"
.SH NAME
intel_gpu_dump \- Print out debugging information on the state of the
Intel GPU.
.SH SYNOPSIS
.nf
.B intel_gpu_dump
.B intel_gpu_dump [ filename ]
.fi
.SH DESCRIPTION
.B intel_gpu_dump
is a tool to log the current state of an Intel GPU
when it is hung, for later analysis. It requires kernel 2.6.30rc1 or newer,
debugfs mounted on /sys/kernel/debug or /debug, and root privilege for
mapping the device to inspect it.
.SS Options
.TP
.B filename
Decodes just one batchbuffer or ringbuffer dump, rather than dumping all
of the GPU state.

18
man/intel_gpu_top.1 Normal file
View File

@ -0,0 +1,18 @@
.\" shorthand for double quote that works everywhere.
.ds q \N'34'
.TH intel_gpu_top 1 "intel_gpu_top 1.0"
.SH NAME
intel_gpu_top \- Display a top-like summary of Intel GPU usage
.SH SYNOPSIS
.B intel_gpu_top
.SH DESCRIPTION
.B intel_gpu_top
is a tool to display usage information of an Intel GPU. It requires root
privilege to map the graphics device.
.PP
Note that idle units are not
displayed, so an entirely idle GPU will only display the ring status and
header.
.SH BUGS
Some GPUs report some units as busy when they aren't, such that even when
idle and not hung, it will show up as 100% busy.

15
man/intel_stepping.1 Normal file
View File

@ -0,0 +1,15 @@
.\" shorthand for double quote that works everywhere.
.ds q \N'34'
.TH intel_stepping 1 "intel_stepping 1.0"
.SH NAME
intel_stepping \- Display the stepping information for an Intel GPU
.SH SYNOPSIS
.B intel_stepping
.SH DESCRIPTION
.B intel_stepping
is a tool to print the stepping information for an Intel GPU, along with
the PCI ID and revision used to determine it.
It requires root privilege to map the graphics device.
.SH BUGS
Not all the known stepping IDs or chipsets are included, so the output
on some devices may not be as specific as possible.

View File

@ -0,0 +1,18 @@
.\" shorthand for double quote that works everywhere.
.ds q \N'34'
.TH intel_upload_blit_large 1 "intel_upload_blit_large 1.0"
.SH NAME
intel_upload_blit_large \- microbenchmark of Intel GPU performance
.SH SYNOPSIS
.nf
.B intel_upload_blit_large
.fi
.SH DESCRIPTION
.B intel_upload_blit_large
is a microbenchmark tool for DRM performance. It should be run with kernel
modesetting enabled, and may require root privilege for correct operation.
It does not require X to be running.
.PP
Given that it is a microbenchmark, its utility is largely for regression
testing of the kernel, and not for general conclusions on graphics
performance.

View File

@ -0,0 +1,18 @@
.\" shorthand for double quote that works everywhere.
.ds q \N'34'
.TH intel_upload_blit_large_gtt 1 "intel_upload_blit_large_gtt 1.0"
.SH NAME
intel_upload_blit_large_gtt \- microbenchmark of Intel GPU performance
.SH SYNOPSIS
.nf
.B intel_upload_blit_large_gtt
.fi
.SH DESCRIPTION
.B intel_upload_blit_large_gtt
is a microbenchmark tool for DRM performance. It should be run with kernel
modesetting enabled, and may require root privilege for correct operation.
It does not require X to be running.
.PP
Given that it is a microbenchmark, its utility is largely for regression
testing of the kernel, and not for general conclusions on graphics
performance.

View File

@ -0,0 +1,18 @@
.\" shorthand for double quote that works everywhere.
.ds q \N'34'
.TH intel_upload_blit_large_map 1 "intel_upload_blit_large_map 1.0"
.SH NAME
intel_upload_blit_large_map \- microbenchmark of Intel GPU performance
.SH SYNOPSIS
.nf
.B intel_upload_blit_large_map
.fi
.SH DESCRIPTION
.B intel_upload_blit_large_map
is a microbenchmark tool for DRM performance. It should be run with kernel
modesetting enabled, and may require root privilege for correct operation.
It does not require X to be running.
.PP
Given that it is a microbenchmark, its utility is largely for regression
testing of the kernel, and not for general conclusions on graphics
performance.

View File

@ -0,0 +1,18 @@
.\" shorthand for double quote that works everywhere.
.ds q \N'34'
.TH intel_upload_blit_small 1 "intel_upload_blit_small 1.0"
.SH NAME
intel_upload_blit_small \- microbenchmark of Intel GPU performance
.SH SYNOPSIS
.nf
.B intel_upload_blit_small
.fi
.SH DESCRIPTION
.B intel_upload_blit_small
is a microbenchmark tool for DRM performance. It should be run with kernel
modesetting enabled, and may require root privilege for correct operation.
It does not require X to be running.
.PP
Given that it is a microbenchmark, its utility is largely for regression
testing of the kernel, and not for general conclusions on graphics
performance.