Fix sections of manual pages and unknown macro. --- a/man/xosd_uninit.3 +++ b/man/xosd_uninit.3 @@ -1,5 +1,5 @@ .\" Hey Emacs! This file is -*- nroff -*- source. -.TH xosd_uninit 3xosd "2002-06-25" "X OSD Library" +.TH xosd_uninit 3 "2002-06-25" "X OSD Library" .SH NAME xosd_uninit \- Destroy a XOSD window .SH SYNOPSIS @@ -20,5 +20,4 @@ The on-screen display object to act on. On success, a zero is returned. On error, \-1 is returned. .SH "SEE ALSO" -.BR xosd_init (3) - +.BR xosd_init (3). --- a/man/xosd_is_onscreen.3 +++ b/man/xosd_is_onscreen.3 @@ -17,7 +17,7 @@ .el .ne 3 .IP "\\$1" \\$2 .. -.TH "XOSD_IS_ONSCREEN" 3xosd "" "" "" +.TH "XOSD_IS_ONSCREEN" 3 "" "" "" .SH NAME xosd_is_onscreen \- Returns wether the XOSD window is shown .SH "SYNOPSIS" @@ -34,10 +34,10 @@ xosd\ *\fBxosd_is_onscreen\fR\ (xosd\ \f .SH "DESCRIPTION" .PP -\fBosd_is_onscreen\fR determines weather a XOSD window, is currently being shown (is mapped to the X display). Because XOSD displays data asynchronously (see \fBxosd_display\fR(3xosd) for details) it can be difficult to know if data is being displayed, \fBxosd_is_onscreen\fR solves this problem. +\fBosd_is_onscreen\fR determines weather a XOSD window, is currently being shown (is mapped to the X display). Because XOSD displays data asynchronously (see \fBxosd_display\fR(3) for details) it can be difficult to know if data is being displayed, \fBxosd_is_onscreen\fR solves this problem. .PP -Call \fBxosd_show\fR(3xosd) or \fBxosd_hide\fR(3xosd) to alter the visibility of the XOSD window. +Call \fBxosd_show\fR(3) or \fBxosd_hide\fR(3) to alter the visibility of the XOSD window. .SH "ARGUMENTS" @@ -48,7 +48,7 @@ The XOSD window to query. .SH "RETURN VALUE" .PP -A 1 is returned if the window is onscreen (mapped), or 0 if it is hidden (unmapped). On error, -1 is returned and \fIxosd_error\fR is set to indicate the reason for the error. +A 1 is returned if the window is onscreen (mapped), or 0 if it is hidden (unmapped). On error, \-1 is returned and \fIxosd_error\fR is set to indicate the reason for the error. .SH "ENVIRONMENT" @@ -74,5 +74,4 @@ There are no known bugs with \fBxosd_is_ .SH "SEE ALSO" .PP - \fBxosd_display\fR(3xosd), \fBxosd_show\fR(3xosd), \fBxosd_hide\fR(3xosd) - + \fBxosd_display\fR(3), \fBxosd_show\fR(3), \fBxosd_hide\fR(3). --- a/man/osd_cat.1 +++ b/man/osd_cat.1 @@ -1,5 +1,5 @@ .\" Emacs, -*- nroff -*- please -.TH XOSD 1xosd "January 2001" "X OSD cat" +.TH XOSD 1 "January 2001" "X OSD cat" .SH NAME osd_cat \- X on-screen file displayer .SH SYNOPSIS --- a/man/xosd_set_shadow_offset.3 +++ b/man/xosd_set_shadow_offset.3 @@ -1,5 +1,5 @@ .\" Hey Emacs! This file is -*- nroff -*- source. -.TH xosd_set_shadow_offset 3xosd "2002-06-25" "X OSD Library" +.TH xosd_set_shadow_offset 3 "2002-06-25" "X OSD Library" .SH NAME xosd_set_shadow_offset \- Change the shadow-offset of the XOSD window .SH SYNOPSIS @@ -24,5 +24,5 @@ Offset of black shadow from main text, i On success, a zero is returned. On error, \-1 is returned. .SH "SEE ALSO" -.BR xosd_init (3xosd), -.BR xosd_display (3xosd) \ No newline at end of file +.BR xosd_init (3), +.BR xosd_display (3). --- a/man/xosd_show.3 +++ b/man/xosd_show.3 @@ -1,5 +1,5 @@ .\" Hey Emacs! This file is -*- nroff -*- source. -.TH xosd_show 3xosd "2002-06-25" "X OSD Library" +.TH xosd_show 3 "2002-06-25" "X OSD Library" .SH NAME xosd_show \- make the XOSD window visible .SH SYNOPSIS @@ -11,7 +11,7 @@ xosd_show \- make the XOSD window visibl Call .B xosd_show to redisplay the data that has been previously displayed using -.BI xosd_display (3xosd). +.BI xosd_display (3). .SH ARGUMENTS .IP \fIosd\fP 1i @@ -20,7 +20,6 @@ The on-screen display object to act on. On success, a zero is returned. On error, \-1 is returned. .SH "SEE ALSO" -.BR xosd_init (3xosd), -.BR xosd_display (3xosd), -.BR xosd_hide (3xosd) - +.BR xosd_init (3), +.BR xosd_display (3), +.BR xosd_hide (3). --- a/man/xosd_set_pos.3 +++ b/man/xosd_set_pos.3 @@ -1,5 +1,5 @@ .\" Hey Emacs! This file is -*- nroff -*- source. -.TH xosd_set_pos 3xosd "2002-06-25" "X OSD Library" +.TH xosd_set_pos 3 "2002-06-25" "X OSD Library" .SH NAME xosd_set_pos \- Change the position of the XOSD window .SH SYNOPSIS @@ -10,7 +10,7 @@ xosd_set_pos \- Change the position of t .SH DESCRIPTION .B xosd_set_pos changes the position of the XOSD window, which was initially set when -.BR xosd_init (3xosd) +.BR xosd_init (3) was called. .SH ARGUMENTS @@ -26,5 +26,5 @@ or On success, a zero is returned. On error, \-1 is returned. .SH "SEE ALSO" -.BR xosd_init (3xosd) -.BR xosd_set_offset (3xosd) \ No newline at end of file +.BR xosd_init (3), +.BR xosd_set_offset (3). --- a/man/xosd_set_bar_length.3 +++ b/man/xosd_set_bar_length.3 @@ -17,7 +17,7 @@ .el .ne 3 .IP "\\$1" \\$2 .. -.TH "XOSD_SET_BAR_LENGTH" 3xosd "" "" "" +.TH "XOSD_SET_BAR_LENGTH" 3 "" "" "" .SH NAME xosd_set_bar_length \- Change the length of the percentage bar or slider .SH "SYNOPSIS" @@ -44,12 +44,12 @@ The XOSD window to alter. .TP \fIdisplayPercentage\fR -The percentage of the display to be used up by the slider or percentage bar, as an interger between 0 and 100. Setting \fIdisplayPercentage\fR to -1 reverts to the default behaviour. +The percentage of the display to be used up by the slider or percentage bar, as an interger between 0 and 100. Setting \fIdisplayPercentage\fR to \-1 reverts to the default behaviour. .SH "RETURN VALUE" .PP -On success, a zero is returned. On error, -1 is returned and \fIxosd_error\fR is set to indicate the reason for the error. +On success, a zero is returned. On error, \-1 is returned and \fIxosd_error\fR is set to indicate the reason for the error. .SH "ENVIRONMENT" @@ -70,5 +70,4 @@ The XOSD library was originally written .SH "SEE ALSO" .PP - \fBxosd_create\fR(3xosd), \fBxosd_display\fR(3xosd). - + \fBxosd_create\fR(3), \fBxosd_display\fR(3). --- a/man/xosd_set_horizontal_offset.3 +++ b/man/xosd_set_horizontal_offset.3 @@ -1,5 +1,5 @@ .\" Hey Emacs! This file is -*- nroff -*- source. -.TH xosd_set_horizontal_offset 3xosd "2002-06-25" "X OSD Library" +.TH xosd_set_horizontal_offset 3 "2002-06-25" "X OSD Library" .SH NAME xosd_set_horizontal_offset \- Change the indent of the XOSD window .SH SYNOPSIS @@ -19,5 +19,5 @@ Indent from the left of the screen, in p On success, a zero is returned. On error, \-1 is returned. .SH "SEE ALSO" -.BR xosd_create (3xosd), -.BR xosd_set_align (3xosd) +.BR xosd_create (3), +.BR xosd_set_align (3). --- a/man/xosd_get_number_lines.3 +++ b/man/xosd_get_number_lines.3 @@ -1,5 +1,5 @@ .\" Hey Emacs! This file is -*- nroff -*- source. -.TH xosd_get_number_lines 3xosd "2002-06-25" "X OSD Library" +.TH xosd_get_number_lines 3 "2002-06-25" "X OSD Library" .SH NAME xosd_get_number_lines - Retrieve the number of lines the xosd object was initialized to display @@ -15,5 +15,4 @@ will get the number of lines the xosd ob .IP \fIosd\fP 1i The on-screen display object to act on. .SH "SEE ALSO" -.BR xosd_init (3xosd), - +.BR xosd_init (3). --- a/man/xosd_destroy.3 +++ b/man/xosd_destroy.3 @@ -17,7 +17,7 @@ .el .ne 3 .IP "\\$1" \\$2 .. -.TH "XOSD_DESTROY" 3xosd "" "" "" +.TH "XOSD_DESTROY" 3 "" "" "" .SH NAME xosd_destroy \- Destroy an XOSD object .SH "SYNOPSIS" @@ -71,5 +71,4 @@ There are no known bugs with \fBxosd_des .SH "SEE ALSO" .PP - \fBxosd_create\fR(3xosd) - + \fBxosd_create\fR(3). --- a/man/xosd.3 +++ b/man/xosd.3 @@ -1,5 +1,5 @@ .\" Emacs, -*- nroff -*- please -.TH XOSD 3xosd "December 2000" "X OSD Library" +.TH XOSD 3 "December 2000" "X OSD Library" .SH NAME xosd - X on-screen display library .SH SYNOPSIS --- a/man/xosd_set_vertical_offset.3 +++ b/man/xosd_set_vertical_offset.3 @@ -1,5 +1,5 @@ .\" Hey Emacs! This file is -*- nroff -*- source. -.TH xosd_set_vertical_offset 3xosd "2002-06-25" "X OSD Library" +.TH xosd_set_vertical_offset 3 "2002-06-25" "X OSD Library" .SH NAME xosd_set_vertical_offset \- Change the offset of the XOSD window .SH SYNOPSIS @@ -22,5 +22,5 @@ Offset from the top or bottom of the scr On success, a zero is returned. On error, \-1 is returned. .SH "SEE ALSO" -.BR xosd_init (3xosd), -.BR xosd_set_pos (3xosd) +.BR xosd_init (3), +.BR xosd_set_pos (3). --- a/man/xosd_hide.3 +++ b/man/xosd_hide.3 @@ -1,5 +1,5 @@ .\" Hey Emacs! This file is -*- nroff -*- source. -.TH xosd_hide 3xosd "2002-06-25" "X OSD Library" +.TH xosd_hide 3 "2002-06-25" "X OSD Library" .SH NAME xosd_hide \- hide the XOSD window .SH SYNOPSIS @@ -13,11 +13,11 @@ hides (unmaps) the .I xosd window. Call -.BI xosd_show (3xosd) +.BR xosd_show (3) to make the window visible again. When -.BI xosd_display (3xosd) +.BI xosd_display (3) is called data will be shown until the pre-set time has elapsed. By calling @@ -30,7 +30,6 @@ The on-screen display object to act on. On success, a zero is returned. On error, \-1 is returned. .SH "SEE ALSO" -.BR xosd_init (3xosd), -.BR xosd_display (3xosd), -.BR xosd_show (3xosd) - +.BR xosd_init (3), +.BR xosd_display (3), +.BR xosd_show (3). --- a/man/xosd_set_align.3 +++ b/man/xosd_set_align.3 @@ -1,5 +1,5 @@ .\" Hey Emacs! This file is -*- nroff -*- source. -.TH xosd_set_pos 3xosd "2002-06-25" "X OSD Library" +.TH xosd_set_pos 3 "2002-06-25" "X OSD Library" .SH NAME xosd_set_align \- Change the alignment of the XOSD window .SH SYNOPSIS @@ -25,7 +25,7 @@ or On success, a zero is returned. On error, \-1 is returned. .SH "SEE ALSO" -.BR xosd_init (3xosd) -.BR xosd_set_offset (3xosd) -.BR xosd_set_pos (3xosd) -.BR xosd (3xosd) +.BR xosd_init (3), +.BR xosd_set_offset (3), +.BR xosd_set_pos (3), +.BR xosd (3). --- a/man/xosd_display.3 +++ b/man/xosd_display.3 @@ -17,7 +17,7 @@ .el .ne 3 .IP "\\$1" \\$2 .. -.TH "XOSD_DISPLAY" 3xosd "" "" "" +.TH "XOSD_DISPLAY" 3 "" "" "" .SH NAME xosd_display \- Display data to an XOSD window .SH "SYNOPSIS" @@ -37,7 +37,7 @@ int\ \fBxosd_display\fR\ (xosd\ *\fIosd\ \fBxosd_display\fR displays either a string, a percentage bar (like a progress bar) or a slider on an X display. The data is displayed in a borderless shaped-window, so it appears to float on top of the other windows, like the on-screen displays found in many televisions. Users cannot interact with the display in any way. .PP -The data is displayed until the timeout limit, set by calling \fBxosd_set_timeout\fR(3xosd), is reached, but \fBxosd_display\fR returns immediately. If blocking is required \fBxosd_wait_until_no_display\fR(3xosd) should be called after \fBxosd_display\fR. A window that is displaying data can be hidden by calling \fBxosd_hide\fR(3xosd). +The data is displayed until the timeout limit, set by calling \fBxosd_set_timeout\fR(3), is reached, but \fBxosd_display\fR returns immediately. If blocking is required \fBxosd_wait_until_no_display\fR(3) should be called after \fBxosd_display\fR. A window that is displaying data can be hidden by calling \fBxosd_hide\fR(3). .PP The type of data displayed is determined by the \fIcommand\fR argument. There are two types of data that can be displayed: text or integers. @@ -60,7 +60,7 @@ The XOSD window to use as the display. .TP \fIline\fR -The line of the display to change. The value of \fIline\fR must be less than \fInumber_lines\fR, set in the call to \fBxosd_create\fR(3xosd). +The line of the display to change. The value of \fIline\fR must be less than \fInumber_lines\fR, set in the call to \fBxosd_create\fR(3). .TP \fIcommand\fR @@ -72,7 +72,7 @@ One of \fBXOSD_percentage\fR, \fBXOSD_sl If the \fIcommand\fR is either \fBXOSD_percentage\fR or \fBXOSD_slider\fR then the integer value of the bar or slider is returned (between 1 and 100). For \fBXOSD_string\fR and \fBXOSD_printf\fR the number of characters written to the display is returned. .PP -On error -1 is returned and \fIxosd_error\fR is set to indicate the reason for the error. +On error \-1 is returned and \fIxosd_error\fR is set to indicate the reason for the error. .SH "ENVIRONMENT" @@ -101,5 +101,4 @@ There are no known bugs with \fBxosd_dis .SH "SEE ALSO" .PP - \fBxosd_create\fR(3xosd), \fBxosd_set_timeout\fR(3xosd), \fBxosd_wait_until_no_display\fR(3xosd), \fBxosd_hide\fR(3xosd), \fBprintf\fR(3) - + \fBxosd_create\fR(3), \fBxosd_set_timeout\fR(3), \fBxosd_wait_until_no_display\fR(3), \fBxosd_hide\fR(3), \fBprintf\fR(3). --- a/man/xosd-config.1 +++ b/man/xosd-config.1 @@ -11,7 +11,6 @@ and link programs that use \fIlibxosd\fP to the .m4 macros for GNU autoconf that are included with \fIlibxosd\fP. . .SH OPTIONS -.l \fBxosd-config\fP accepts the following options: .TP 8 .B \-\-version --- a/man/xosd_create.3 +++ b/man/xosd_create.3 @@ -17,7 +17,7 @@ .el .ne 3 .IP "\\$1" \\$2 .. -.TH "XOSD_CREATE" 3xosd "" "" "" +.TH "XOSD_CREATE" 3 "" "" "" .SH NAME xosd_create \- Create a new XOSD object .SH "SYNOPSIS" @@ -75,5 +75,4 @@ There are no known bugs with \fBxosd_cre .SH "SEE ALSO" .PP - \fBxosd_destroy\fR(3xosd), \fBxosd_show\fR(3xosd), \fBxosd_set_pos\fR(3xosd), \fBxosd_set_align\fR(3xosd), \fBxosd_set_shadow_offset\fR(3xosd), \fBxosd_set_offset\fR(3xosd), \fBxosd_set_timeout\fR(3xosd), \fBxosd_set_colour\fR(3xosd), \fBxosd_set_font\fR(3xosd), \fBxosd_show\fR(3xosd), \fBxosd_scroll\fR(3xosd), - + \fBxosd_destroy\fR(3), \fBxosd_show\fR(3), \fBxosd_set_pos\fR(3), \fBxosd_set_align\fR(3), \fBxosd_set_shadow_offset\fR(3), \fBxosd_set_offset\fR(3), \fBxosd_set_timeout\fR(3), \fBxosd_set_colour\fR(3), \fBxosd_set_font\fR(3), \fBxosd_show\fR(3), \fBxosd_scroll\fR(3).