[SCM] faac/master: Add manpage from Ubuntu version 1.26-0.1ubuntu2, with manpage hyphen issues corrected

Thu Jun 9 04:52:21 UTC 2011

The following commit has been merged in the master branch:
commit b3dcdca99331ab5ab8cb85c10d720e4f54bf9463
Author: Maia Kozheva <sikon at ubuntu.com>
Date:   Thu Jun 9 11:12:53 2011 +0700

    Add manpage from Ubuntu version 1.26-0.1ubuntu2, with manpage hyphen issues corrected

diff --git a/debian/faac.manpages b/debian/faac.manpages
new file mode 100644
index 0000000..e00a65d
--- /dev/null
+++ b/debian/faac.manpages
@@ -0,0 +1 @@
+debian/manpages/faac.1
diff --git a/debian/manpages/faac.1 b/debian/manpages/faac.1
new file mode 100644
index 0000000..011038d
--- /dev/null
+++ b/debian/manpages/faac.1
@@ -0,0 +1,239 @@
+.\" vim:syn=groff:
+.\" Man page for FAAC
+.TH FAAC 1 "2007-03-27" "" "FAAC Manual"
+.
+.SH NAME
+faac \- encode audio to the MPEG-2/-4 AAC format
+.
+.SH SYNOPSIS
+faac [options] [\-o outfile] infiles ...
+.
+.SH DESCRIPTION
+.PP
+FAAC is a free AAC audio encoder that can compress WAV and raw PCM audio
+files.  AAC is commonly used as the primary format in the Apple iPod and
+iTunes, although several other software and hardware implementations exist
+that can play back AAC files such as FAAD2 and FFmpeg.
+.
+.SH OPTIONS
+.SS "Quality-related options"
+.
+.TP
+.BI \-q " quality"
+Set the default variable bitrate (VBR) quantizer quality in percent.  Default
+is 100 which is approximately 120 kbps VBR for a normal stereo 16-bit 44.1 kHz
+input.  Min value 10, max value 500.
+.
+.TP
+.BI \-b " bitrate"
+Set the average bitrate (ABR) to approximately
+.I bitrate
+kbps.
+.
+.TP
+.BI \-c " freq"
+Set the bandwidth in Hz.  By default, FAAC will automatically adapt the
+maximum value to the input sample rate.
+.
+.PP
+.SS "Input/Output options"
+.
+.TP
+.B \-
+Use stdin as input file.
+.
+.TP
+.BI \-o " outfile"
+Set the output file to
+.I outfile
+; you can use a dash (\*(lq-\*(rq) to specify stdout as the output file.
+.
+.TP
+.B -P
+Enable raw PCM input mode.  By default, this is not enabled and FAAC expects
+a WAV file as input.  Using this option will use the default values for \fB-R\fR,
+\fB-B\fR, and \fB-C\fR unless otherwise modified.
+.
+.TP
+.BI \-R " rate"
+Set the raw PCM input sample rate to \fIrate\fR Hz.  Default is 44100, max is 96000.
+.
+.TP
+.BI \-B " bitsize"
+Set the raw PCM input sample size to \fIbitsize\fR
+bits.  Default is 16, other available sizes are 8, 24, and 32.  Input is
+assumed to be big endian unless otherwise specified with
+.B \-X
+.
+.TP
+.B \-X
+Change raw PCM input byte order from big endian to little endian.
+.
+.TP
+.BI \-C " channels"
+Set the raw PCM input channel count.  Default is 2 (stereo), max is 33 + 1 LFE.
+.
+.TP
+.BI \-I " centre[,lfe]"
+Set the raw PCM input multichannel configuration.
+.I centre
+specifies which channel is the centre channel (default 3), and
+.I lfe
+specifies which channel is the LFE channel (default 4).
+.
+.TP
+.B \-r
+Output file as raw AAC data (i.e. without ADTS headers).
+.
+.PP
+.SS "MP4-specific options"
+.
+.TP
+.B \-w
+Wrap AAC data in an MP4 container.  This is enabled by default for output
+files with the extensions .mp4 and .m4a.
+.
+.TP
+.BI \-\-artist " artist"
+Set artist to
+.I artist
+.
+.TP
+.BI \-\-writer " writer"
+Set writer to
+.I writer
+.
+.TP
+.BI \-\-title " title"
+Set title to
+.I title
+.
+.TP
+.BI \-\-genre " genre"
+Set genre to
+.I genre
+.
+.TP
+.BI \-\-album " album"
+Set album to
+.I album
+.
+.TP
+.B \-\-compilation
+Set compilation
+.
+.TP
+.BI \-\-track " track"
+Set track to \fItrack\fR in the format \*(lqnumber/total\*(rq
+.
+.TP
+.BI \-\-disc " disc"
+Set disc to
+.I disc
+in the format \*(lqnumber/total\*(rq
+.
+.TP
+.BI \-\-year " year"
+Set year to
+.I year
+.
+.TP
+.BI \-\-cover\-art " file"
+Set cover art to image in \fIfile\fR; supported formats are GIF, JPEG, and PNG.
+.
+.TP
+.BI \-\-comment " comment"
+Set comment to
+.I comment
+.
+.PP
+.SS "Expert options"
+.
+.TP
+.B \-\-no\-tns
+Disable temporal noise shaping coding.
+.
+.TP
+.B \-\-no\-midside
+Disable mid/side coding.
+.
+.TP
+.BI \-\-mpeg\-vers " version"
+Set the AAC MPEG version to either 2 or 4.
+.
+.TP
+.BI \-\-obj\-type " type"
+Set the AAC object type to LC (Low Complexity, default), Main, or LTP
+(Long Term Prediction).
+.
+.TP
+.BI \-\-shortctl " type"
+Force block type of short (1), long (2), or both (by default).
+.
+.SH CONFORMING TO
+FAAC conforms to \fIISO/IEC 14496\fR (MPEG-4) in parts 1 (Systems), 3 (Audio),
+and 14 (MPEG-4 File Format), as well as \fIISO/IEC 13818\fR (MPEG-2) part 7
+(Advanced Audio Coding).  Not all audio profiles/codecs are supported, but the
+most common (LC-AAC, or Low Complexity) is supported fully.
+.
+.SH BUGS
+Any bugs should be posted on <http://www.audiocoding.com/modules/newbb/viewforum.php?forum=3>
+.
+.SH AUTHORS
+FAAC was written by Menno Bakker and Krzysztof Nikiel, and it is based on the
+ISO/IEC 14496-5 reference encoder.
+.br
+This man page written by Matt Sicker <boards at gmail.com> for use in the Debian
+and Ubuntu operating system distributions but may be modified and redistributed
+by anyone else for any reason provided this notice is preserved.
+.
+.SH COPYRIGHT
+FAAC is Copyright (c) 1999-2001 Menno Bakker, and Copyright (c) 2002-2003
+Krzysztof Nikiel.  You may redistribute, modify, etc., it under the terms
+of the GNU Lesser General Public License version 2.1 or any later version
+published by the Free Software Foundation.
+.PP
+The original ISO/IEC 14496-5 source code is licensed as follows:
+.RS
+This software module was originally developed by
+
+FirstName LastName (CompanyName)
+
+and edited by
+
+FirstName LastName (CompanyName)
+FirstName LastName (CompanyName)
+
+in the course of development of the MPEG-2 NBC/MPEG-4 Audio standard
+ISO/IEC 13818-7, 14496-1,2 and 3. This software module is an
+implementation of a part of one or more MPEG-2 NBC/MPEG-4 Audio tools
+as specified by the MPEG-2 NBC/MPEG-4 Audio standard. ISO/IEC gives
+users of the MPEG-2 NBC/MPEG-4 Audio standards free license to this
+software module or modifications thereof for use in hardware or
+software products claiming conformance to the MPEG-2 NBC/ MPEG-4 Audio
+standards. Those intending to use this software module in hardware or
+software products are advised that this use may infringe existing
+patents. The original developer of this software module and his/her
+company, the subsequent editors and their companies, and ISO/IEC have
+no liability for use of this software module or modifications thereof
+in an implementation. Copyright is not released for non MPEG-2
+NBC/MPEG-4 Audio conforming products. The original developer retains
+full right to use the code for his/her own purpose, assign or donate
+the code to a third party and to inhibit third party from using the
+code for non MPEG-2 NBC/MPEG-4 Audio conforming products. This
+copyright notice must be included in all copies or derivative works.
+
+Copyright (c) 1997.
+.RE
+.PP
+Please also note that in certain jurisdictions, the AAC standard may be
+covered by software patents.  This program is not distributed with any
+warranty or indemnity from patent royalties and as such should be looked
+into by oneself if one wishes to modify or redistribute FAAC.
+.
+.SH SEE ALSO
+.BR faad (1) ,
+.BR ffmpeg (1) ,
+.BR sox (1)
+.br
+<http://www.audiocoding.com/> AudioCoding.com home page

-- 
faac packaging

