Author: Andreas Beckmann Description: fix manpage hyphenation and typos --- a/man/man1/papi_avail.1 +++ b/man/man1/papi_avail.1 @@ -10,23 +10,23 @@ papi_avail - provides availability and detail information for PAPI preset events\&. .SH "Synopsis" .PP -papi_avail [-adht] [-e event] +papi_avail [\-adht] [\-e event] .SH "Description" .PP -papi_avail is a PAPI utility program that reports information about the current PAPI installation and supported preset events\&. Using the -e option, it will also display information about specific native events\&. +papi_avail is a PAPI utility program that reports information about the current PAPI installation and supported preset events\&. Using the \-e option, it will also display information about specific native events\&. .SH "Options" .PP .PD 0 .IP "\(bu" 2 --a Display only the available PAPI preset events\&. +\-a Display only the available PAPI preset events\&. .IP "\(bu" 2 --d Display PAPI preset event information in a more detailed format\&. +\-d Display PAPI preset event information in a more detailed format\&. .IP "\(bu" 2 --h Display help information about this utility\&. +\-h Display help information about this utility\&. .IP "\(bu" 2 --t Display the PAPI preset event information in a tabular format\&. This is the default\&. +\-t Display the PAPI preset event information in a tabular format\&. This is the default\&. .IP "\(bu" 2 --e < event > Display detailed event information for the named event\&. This event can be either a preset or a native event\&. +\-e < event > Display detailed event information for the named event\&. This event can be either a preset or a native event\&. .PP .SH "Bugs" .PP --- a/man/man1/papi_component_avail.1 +++ b/man/man1/papi_component_avail.1 @@ -17,9 +17,9 @@ .PP .PD 0 .IP "\(bu" 2 --h help message +\-h help message .IP "\(bu" 2 --d provide detailed information about each component\&. +\-d provide detailed information about each component\&. .PP .SH "Bugs" .PP --- a/man/man1/papi_cost.1 +++ b/man/man1/papi_cost.1 @@ -10,7 +10,7 @@ papi_cost - computes execution time costs for basic PAPI operations\&. .SH "Synopsis" .PP -papi_cost [-dhs] [-b bins] [-t threshold] +papi_cost [\-dhs] [\-b bins] [\-t threshold] .SH "Description" .PP papi_cost is a PAPI utility program that computes the min / max / mean / std\&. deviation of execution times for PAPI start/stop pairs and for PAPI reads\&. This information provides the basic operating cost to a user's program for collecting hardware counter data\&. Command line options control display capabilities\&. @@ -18,15 +18,15 @@ .PP .PD 0 .IP "\(bu" 2 --b < bins > Define the number of bins into which the results are partitioned for display\&. The default is 100\&. +\-b < bins > Define the number of bins into which the results are partitioned for display\&. The default is 100\&. .IP "\(bu" 2 --d Display a graphical distribution of costs in a vertical histogram\&. +\-d Display a graphical distribution of costs in a vertical histogram\&. .IP "\(bu" 2 --h Display help information about this utility\&. +\-h Display help information about this utility\&. .IP "\(bu" 2 --s Show the number of iterations in each of the first 10 standard deviations above the mean\&. +\-s Show the number of iterations in each of the first 10 standard deviations above the mean\&. .IP "\(bu" 2 --t < threshold > Set the threshold for the number of iterations to measure costs\&. The default is 100,000\&. +\-t < threshold > Set the threshold for the number of iterations to measure costs\&. The default is 100,000\&. .PP .SH "Bugs" .PP --- a/man/man1/papi_decode.1 +++ b/man/man1/papi_decode.1 @@ -10,7 +10,7 @@ papi_decode - provides availability and detail information for PAPI preset events\&. .SH "Synopsis" .PP -papi_decode [-ah] +papi_decode [\-ah] .SH "Description" .PP papi_decode is a PAPI utility program that converts the PAPI presets for the existing library into a comma separated value format that can then be viewed or modified in spreadsheet applications or text editors, and can be supplied to PAPI_encode_events (3) as a way of adding or modifying event definitions for specialized applications\&. The format for the csv output consists of a line of field names, followed by a blank line, followed by one line of comma separated values for each event contained in the preset table\&. A portion of this output (for Pentium 4) is shown below: @@ -28,9 +28,9 @@ .PP .PD 0 .IP "\(bu" 2 --a Convert only the available PAPI preset events\&. +\-a Convert only the available PAPI preset events\&. .IP "\(bu" 2 --h Display help information about this utility\&. +\-h Display help information about this utility\&. .PP .SH "Bugs" .PP --- a/man/man1/papi_multiplex_cost.1 +++ b/man/man1/papi_multiplex_cost.1 @@ -10,7 +10,7 @@ papi_multiplex_cost - computes execution time costs for basic PAPI operations on multiplexed EventSets\&. .SH "Synopsis" .PP -papi_cost [-m, --min < min >] [-x, --max < max >] [-k,-s] +papi_cost [\-m, \-\-min < min >] [\-x, \-\-max < max >] [\-k,\-s] .SH "Description" .PP papi_multiplex_cost is a PAPI utility program that computes the min / max / mean / std\&. deviation of execution times for PAPI start/stop pairs and for PAPI reads on multiplexed eventsets\&. This information provides the basic operating cost to a user's program for collecting hardware counter data\&. Command line options control display capabilities\&. @@ -18,15 +18,15 @@ .PP .PD 0 .IP "\(bu" 2 --m < Min number of events to test > +\-m < Min number of events to test > .IP "\(bu" 2 --x < Max number of events to test > +\-x < Max number of events to test > .IP "\(bu" 2 --k, Do not time kernel multiplexing +\-k, Do not time kernel multiplexing .IP "\(bu" 2 --s, Do not ime software multiplexed EventSets +\-s, Do not ime software multiplexed EventSets .IP "\(bu" 2 --t THREASHOLD, Test with THRESHOLD iterations of counting loop\&. +\-t THREASHOLD, Test with THRESHOLD iterations of counting loop\&. .PP .SH "Bugs" .PP --- a/man/man1/papi_native_avail.1 +++ b/man/man1/papi_native_avail.1 @@ -17,34 +17,34 @@ .PP .PD 0 .IP "\(bu" 2 ---help, -h print this help message +\-\-help, \-h print this help message .IP "\(bu" 2 --d display detailed information about native events +\-d display detailed information about native events .IP "\(bu" 2 --e EVENTNAME display detailed information about named native event +\-e EVENTNAME display detailed information about named native event .IP "\(bu" 2 --i EVENTSTR include only event names that contain EVENTSTR +\-i EVENTSTR include only event names that contain EVENTSTR .IP "\(bu" 2 --x EVENTSTR exclude any event names that contain EVENTSTR +\-x EVENTSTR exclude any event names that contain EVENTSTR .IP "\(bu" 2 ---noumasks suppress display of Unit Mask information +\-\-noumasks suppress display of Unit Mask information .PP .PP Processor-specific options .PD 0 .IP "\(bu" 2 ---darr display events supporting Data Address Range Restriction +\-\-darr display events supporting Data Address Range Restriction .IP "\(bu" 2 ---dear display Data Event Address Register events only +\-\-dear display Data Event Address Register events only .IP "\(bu" 2 ---iarr display events supporting Instruction Address Range Restriction +\-\-iarr display events supporting Instruction Address Range Restriction .IP "\(bu" 2 ---iear display Instruction Event Address Register events only +\-\-iear display Instruction Event Address Register events only .IP "\(bu" 2 ---opcm display events supporting OpCode Matching +\-\-opcm display events supporting OpCode Matching .IP "\(bu" 2 ---nogroups suppress display of Event grouping information +\-\-nogroups suppress display of Event grouping information .PP .SH "Bugs" .PP --- a/man/man1/papi_xml_event_info.1 +++ b/man/man1/papi_xml_event_info.1 @@ -19,13 +19,13 @@ .PP .PD 0 .IP "\(bu" 2 --h print help message +\-h print help message .IP "\(bu" 2 --p print only preset events +\-p print only preset events .IP "\(bu" 2 --n print only native events +\-n print only native events .IP "\(bu" 2 --c COMPONENT print only events from component number COMPONENT event1, event2, \&.\&.\&. Print only events that can be created in the same event set with the events event1, event2, etc\&. +\-c COMPONENT print only events from component number COMPONENT event1, event2, \&.\&.\&. Print only events that can be created in the same event set with the events event1, event2, etc\&. .PP .SH "Bugs" .PP --- a/man/man3/PAPI_accum.3 +++ b/man/man3/PAPI_accum.3 @@ -52,7 +52,7 @@ * if (PAPI_accum( EventSet, values ) != PAPI_OK ) * handle_error( 1 ); * // values[0] now equals 200 -* values[0] = -100; +* values[0] = \-100; * do_100events( ); * if (PAPI_accum( EventSet, values ) != PAPI_OK ) * handle_error( 1 ); --- a/man/man3/PAPI_accum_counters.3 +++ b/man/man3/PAPI_accum_counters.3 @@ -57,7 +57,7 @@ if ( PAPI_accum_counters( values, num_hwcntrs ) != PAPI_OK ) handle_error(1); // values[0] now equals 200 -values[0] = -100; +values[0] = \-100; do_100events(); if ( PAPI_accum_counters(values, num_hwcntrs ) != PAPI_OK ) handle_error(); --- a/man/man3/PAPI_attach.3 +++ b/man/man3/PAPI_attach.3 @@ -21,7 +21,7 @@ PAPI_attach is a wrapper function that calls PAPI_set_opt to allow PAPI to monitor performance counts on a thread other than the one currently executing. This is sometimes referred to as third party monitoring. -PAPI_attach connects the specified EventSet to the specifed thread; +PAPI_attach connects the specified EventSet to the specified thread; PAPI_detach breaks that connection and restores the EventSet to the original executing thread. --- a/man/man3/PAPI_detach.3 +++ b/man/man3/PAPI_detach.3 @@ -21,7 +21,7 @@ PAPI_detach is a wrapper function that calls PAPI_set_opt to allow PAPI to monitor performance counts on a thread other than the one currently executing. This is sometimes referred to as third party monitoring. -PAPI_attach connects the specified EventSet to the specifed thread; +PAPI_attach connects the specified EventSet to the specified thread; PAPI_detach breaks that connection and restores the EventSet to the original executing thread. --- a/man/man3/PAPI_read.3 +++ b/man/man3/PAPI_read.3 @@ -57,7 +57,7 @@ * if (PAPI_accum(EventSet, values) != PAPI_OK) * handle_error(1); * // values[0] now equals 200 -* values[0] = -100; +* values[0] = \-100; * do_100events(); * if (PAPI_accum(EventSet, values) != PAPI_OK) * handle_error(1); --- a/man/man3/PAPI_read_counters.3 +++ b/man/man3/PAPI_read_counters.3 @@ -57,7 +57,7 @@ if ( PAPI_accum_counters( values, num_hwcntrs ) != PAPI_OK ) handle_error(1); // values[0] now equals 200 -values[0] = -100; +values[0] = \-100; do_100events(); if ( PAPI_accum_counters(values, num_hwcntrs ) != PAPI_OK ) handle_error(); --- a/man/man3/PAPI_set_debug.3 +++ b/man/man3/PAPI_set_debug.3 @@ -48,7 +48,7 @@ .br The current debug level is used by both the internal error and debug message handler subroutines\&. .br - The debug handler is only used if the library was compiled with -DDEBUG\&. + The debug handler is only used if the library was compiled with \-DDEBUG\&. .br The debug handler is called when there is an error upon a call to the PAPI API\&. .br --- a/man/man1/papi_command_line.1 +++ b/man/man1/papi_command_line.1 @@ -13,11 +13,11 @@ .PP .PD 0 .IP "\(bu" 2 --u Display output values as unsigned integers +\-u Display output values as unsigned integers .IP "\(bu" 2 --x Display output values as hexadecimal +\-x Display output values as hexadecimal .IP "\(bu" 2 --h Display help information about this utility\&. +\-h Display help information about this utility\&. .PP .SH "Bugs" .PP --- a/man/man1/papi_hybrid_native_avail.1 +++ b/man/man1/papi_hybrid_native_avail.1 @@ -17,36 +17,36 @@ .PP .PD 0 .IP "\(bu" 2 ---help, -h print this help message +\-\-help, \-h print this help message .IP "\(bu" 2 --d display detailed information about native events +\-d display detailed information about native events .IP "\(bu" 2 --e EVENTNAME display detailed information about named native event +\-e EVENTNAME display detailed information about named native event .IP "\(bu" 2 --i EVENTSTR include only event names that contain EVENTSTR +\-i EVENTSTR include only event names that contain EVENTSTR .IP "\(bu" 2 --x EVENTSTR exclude any event names that contain EVENTSTR +\-x EVENTSTR exclude any event names that contain EVENTSTR .IP "\(bu" 2 ---noumasks suppress display of Unit Mask information +\-\-noumasks suppress display of Unit Mask information .IP "\(bu" 2 ---mic < index > report events on the specified target MIC device +\-\-mic < index > report events on the specified target MIC device .PP .PP Processor-specific options .PD 0 .IP "\(bu" 2 ---darr display events supporting Data Address Range Restriction +\-\-darr display events supporting Data Address Range Restriction .IP "\(bu" 2 ---dear display Data Event Address Register events only +\-\-dear display Data Event Address Register events only .IP "\(bu" 2 ---iarr display events supporting Instruction Address Range Restriction +\-\-iarr display events supporting Instruction Address Range Restriction .IP "\(bu" 2 ---iear display Instruction Event Address Register events only +\-\-iear display Instruction Event Address Register events only .IP "\(bu" 2 ---opcm display events supporting OpCode Matching +\-\-opcm display events supporting OpCode Matching .IP "\(bu" 2 ---nogroups suppress display of Event grouping information +\-\-nogroups suppress display of Event grouping information .PP .SH "Bugs" .PP --- a/man/man3/PAPI_thread_id.3 +++ b/man/man3/PAPI_thread_id.3 @@ -16,7 +16,7 @@ .nf @retval PAPI_EMISC is returned if there are no threads registered. -@retval -1 +@retval \-1 is returned if the thread id function returns an error. This function returns a valid thread identifier.