Description: Some syntax fixes for manpages Author: Emmet Hikory Last-Update: 2011-02-22 Index: wildmidi-0.2.3.4/docs/wildmidi.cfg.5 =================================================================== --- wildmidi-0.2.3.4.orig/docs/wildmidi.cfg.5 +++ wildmidi-0.2.3.4/docs/wildmidi.cfg.5 @@ -6,7 +6,7 @@ .B libWildMidi .PP .SH DESCRIPTION -Contains the patch configuration for libWildMidi and location of Gravis Ultrasound compatable patch files. +Contains the patch configuration for libWildMidi and location of Gravis Ultrasound compatible patch files. .PP .nf dir ~/guspats/ @@ -51,11 +51,11 @@ Example: 0 acpiano.pat amp=110 .PP .RS -.PI "\fIpatchno\fP" +.IP "\fIpatchno\fP" This is the MIDI patch number the instrument belongs to. .PP -.PI "\fIpatchfile\fP" -The filename of the Gravis Ulstrasound compatable patch file. If the filename is missing the .pat extention, libWildMidi will add .pat when attempting to load the file. +.IP "\fIpatchfile\fP" +The filename of the Gravis Ulstrasound compatible patch file. If the filename is missing the .pat extension, libWildMidi will add .pat when attempting to load the file. .PP .IP "\fBamp=\fP\fIvolume\fP" Force the volume of the samples in this patch to \fIvolume\fP prior to using it. Index: wildmidi-0.2.3.4/docs/WildMidi_Close.3 =================================================================== --- wildmidi-0.2.3.4.orig/docs/WildMidi_Close.3 +++ wildmidi-0.2.3.4/docs/WildMidi_Close.3 @@ -15,7 +15,7 @@ The indentifier obtained from opening a midi file with \fBWildMidi_Open\fR(3)\fP or \fBWildMidi_OpenBuffer\fR(3)\fP .PP .SH "RETURN VALUE" -returns -1 on error, otherwise returns 0 +returns \-1 on error, otherwise returns 0 .PP .SH SEE ALSO .BR WildMidi_GetString (3) , @@ -34,7 +34,7 @@ .SH AUTHOR Chris Ison .SH COPYRIGHT -Copyright (C) Chris Ison 2001-2010 +Copyright (C) Chris Ison 2001\-2010 .PP This file is part of WildMIDI. .PP @@ -45,5 +45,5 @@ You should have received a copy of the GNU General Public License and the GNU Lesser General Public License along with WildMIDI. If not, see . .PP .PP -This manpage is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA. +This manpage is licensed under the Creative Commons Attribution\-Share Alike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA. .PP Index: wildmidi-0.2.3.4/docs/WildMidi_GetOutput.3 =================================================================== --- wildmidi-0.2.3.4.orig/docs/WildMidi_GetOutput.3 +++ wildmidi-0.2.3.4/docs/WildMidi_GetOutput.3 @@ -25,7 +25,7 @@ The size of the buffer in bytes. Since libWildMidi processes the audio in 16bit interleaved stereo format, this value needs to be a multiple of 4. .PP .SH "RETURN VALUE" -Returns -1 on error and an error message sent to stderr, 0 when there is no more audio data, otherwise the number of bytes of audio data writen to \fIbuffer\fP. +Returns \-1 on error and an error message sent to stderr, 0 when there is no more audio data, otherwise the number of bytes of audio data writen to \fIbuffer\fP. .PP NOTE: if the return value is less than the size you gave, this does not denote an error, it simply means the lib reached the end of the midi before it could fill the buffer. .PP @@ -47,7 +47,7 @@ Chris Ison .PP .SH COPYRIGHT -Copyright (C) Chris Ison 2001-2010 +Copyright (C) Chris Ison 2001\-2010 .PP This file is part of WildMIDI. .PP @@ -58,5 +58,5 @@ You should have received a copy of the GNU General Public License and the GNU Lesser General Public License along with WildMIDI. If not, see . .PP .PP -This manpage is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA. +This manpage is licensed under the Creative Commons Attribution\-Share Alike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA. .PP Index: wildmidi-0.2.3.4/docs/WildMidi_MasterVolume.3 =================================================================== --- wildmidi-0.2.3.4.orig/docs/WildMidi_MasterVolume.3 +++ wildmidi-0.2.3.4/docs/WildMidi_MasterVolume.3 @@ -13,7 +13,7 @@ Sets the overall library volume level to \fImaster_volume\fP. The range of \fImaster_volume\fP is between 0 and 127 with 100 being the default. .PP .SH "RETURN VALUE" -Returns -1 on error otherwise returns 0 +Returns \-1 on error otherwise returns 0 .PP .SH SEE ALSO .BR WildMidi_GetString (3) , @@ -33,7 +33,7 @@ Chris Ison .PP .SH COPYRIGHT -Copyright (C) Chris Ison 2001-2010 +Copyright (C) Chris Ison 2001\-2010 .PP This file is part of WildMIDI. .PP @@ -44,5 +44,5 @@ You should have received a copy of the GNU General Public License and the GNU Lesser General Public License along with WildMIDI. If not, see . .PP .PP -This manpage is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA. +This manpage is licensed under the Creative Commons Attribution\-Share Alike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA. .PP Index: wildmidi-0.2.3.4/docs/WildMidi_SetOption.3 =================================================================== --- wildmidi-0.2.3.4.orig/docs/WildMidi_SetOption.3 +++ wildmidi-0.2.3.4/docs/WildMidi_SetOption.3 @@ -13,35 +13,35 @@ .SH DESCRIPTION Set a library option for a specific midi. .PP -.IP \fIhandle\fP +.IP "\fIhandle\fP" The indentifier obtained from opening a midi file with \fBWildMidi_Open\fR(3)\fP or \fBWildMidi_OpenBuffer\fR(3)\fP .PP .B \fIoptions\fP The option or options you wish to change. .PP .RS -.IP WM_MO_LOG_VOLUME +.IP "WM_MO_LOG_VOLUME" By default the library uses linear volume levels typically used in computer MIDI players. These can differ somewhat to volume levels found on some midi hardware which may use a volume curve based on decibels. This option sets the volume levels to what you'd expect on such devices. .PP -.IP WM_MO_ENHANCED_RESAMPLING +.IP "WM_MO_ENHANCED_RESAMPLING" By default libWildMidi uses linear interpolation for the resampling of the sound samples. Setting this option enables the library to use a resampling method that attempts to fill in the gaps giving richer sound. .PP -.IP WM_MO_REVERB +.IP "WM_MO_REVERB" libWildMidi has an 8 reflection reverb engine. Use this option to give more depth to the output. .PP .RE -.IP setting +.IP "setting" To turn on an option, repeat that option here. To turn off an option, do not put the option here. .PP -.IP Example: To turn on Reverb +.IP "Example: To turn on Reverb" WildMidi_SetOption(handle, WM_MO_REVERB, WM_MO_REVERB); -.IP Example: To turn off Reverb +.IP "Example: To turn off Reverb" WildMidi_SetOption(handle, WM_MO_REVERB, NULL); -.IP Example: To turn on Reverb and Enhanced Resampling +.IP "Example: To turn on Reverb and Enhanced Resampling" WildMidi_SetOption(handle, (WM_MO_REVERB | WM_MO_ENHANCED_RESAMPLING), (WM_MO_REVERB | WM_MO_ENHANCED_RESAMPLING)); .PP .SH "RETURN VALUE" -returns -1 on error, otherwise returns 0 +returns \-1 on error, otherwise returns 0 .SH SEE ALSO .BR WildMidi_GetString (3) , .BR WildMidi_Init (3) , @@ -61,7 +61,7 @@ Chris Ison .PP .SH COPYRIGHT -Copyright (C) Chris Ison 2001-2010 +Copyright (C) Chris Ison 2001\-2010 .PP This file is part of WildMIDI. .PP @@ -72,5 +72,5 @@ You should have received a copy of the GNU General Public License and the GNU Lesser General Public License along with WildMIDI. If not, see . .PP .PP -This manpage is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA. +This manpage is licensed under the Creative Commons Attribution\-Share Alike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA. .PP