Skip to content

Commit

Permalink
add man page for wvtag and update the other man pages (--import-id3)
Browse files Browse the repository at this point in the history
  • Loading branch information
dbry committed Jan 14, 2017
1 parent 958c83f commit 98601d3
Show file tree
Hide file tree
Showing 9 changed files with 433 additions and 25 deletions.
2 changes: 1 addition & 1 deletion man/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
man_MANS = wavpack.1 wvgain.1 wvunpack.1
man_MANS = wavpack.1 wvgain.1 wvunpack.1 wvtag.1

if ENABLE_MAN
%.1: %.xml
Expand Down
20 changes: 15 additions & 5 deletions man/wavpack.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: wavpack
.\" Author: Sebastian Dröge <slomo@debian.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 2016-11-13
.\" Date: 2017-01-13
.\" Manual: WavPack Executable Programs
.\" Source: WavPack 5.0.0
.\" Source: WavPack 5.1.0
.\" Language: English
.\"
.TH "WAVPACK" "1" "2016\-11\-13" "WavPack 5\&.0\&.0" "WavPack Executable Programs"
.TH "WAVPACK" "1" "2017\-01\-13" "WavPack 5\&.1\&.0" "WavPack Executable Programs"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down Expand Up @@ -218,6 +218,15 @@ display extended help
ignore length in wav header (no pipe output allowed)
.RE
.PP
\fB\-\-import\-id3\fR
.RS 4
import applicable tag items from ID3v2\&.3 tag present in DSF files into APEv2 tag (if there are > 1 MB cover images present add
\fB\-\-allow\-huge\-tags\fR
to include them, and
\fB\-r\fR
if you do not want large images appearing twice in the WavPack file, although this will remove the entire ID3 tag wrapper)
.RE
.PP
\fB\-j\fR\fB\fIn\fR\fR
.RS 4
joint\-stereo override (0 = left/right, 1 = mid/side)
Expand Down Expand Up @@ -373,7 +382,8 @@ don\*(Aqt set (n = 0 or omitted) or set (n = 1) console title to indicate progre
.SH "SEE ALSO"
.PP
\fBwvunpack\fR(1),
\fBwvgain\fR(1)
\fBwvgain\fR(1),
\fBwvtag\fR(1)
.PP
Please visit www\&.wavpack\&.com for more information
.SH "COPYRIGHT"
Expand All @@ -399,5 +409,5 @@ Updates
.br
Copyright \(co 2005 Sebastian Dröge
.br
Copyright \(co 2016 David Bryant
Copyright \(co 2017 David Bryant
.br
16 changes: 13 additions & 3 deletions man/wavpack.xml
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@
<holder>Sebastian Dröge</holder>
</copyright>
<copyright>
<year>2016</year>
<year>2017</year>
<holder>David Bryant</holder>
</copyright>
<date>2016-11-13</date>
<date>2017-01-13</date>
</refentryinfo>
<refmeta>
<refentrytitle>wavpack</refentrytitle>
<refmiscinfo class="source">WavPack</refmiscinfo>
<refmiscinfo class="manual">WavPack Executable Programs</refmiscinfo>
<refmiscinfo class="version">5.0.0</refmiscinfo>
<refmiscinfo class="version">5.1.0</refmiscinfo>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
Expand Down Expand Up @@ -172,6 +172,13 @@
<term> <option>-i</option> </term>
<listitem> <para>ignore length in wav header (no pipe output allowed)</para> </listitem>
</varlistentry>
<varlistentry>
<term> <option>--import-id3</option> </term>
<listitem> <para>import applicable tag items from ID3v2.3 tag present in DSF files into APEv2 tag (if there are > 1 MB cover images present add
<option>--allow-huge-tags</option> to include them, and <option>-r</option> if you do not want large images appearing twice in the WavPack file,
although this will remove the entire ID3 tag wrapper)
</para> </listitem>
</varlistentry>
<varlistentry>
<term> <option>-j<replaceable>n</replaceable></option> </term>
<listitem> <para>joint-stereo override (0 = left/right, 1 = mid/side)</para> </listitem>
Expand Down Expand Up @@ -316,6 +323,9 @@
</citerefentry>, <citerefentry>
<refentrytitle>wvgain</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>, <citerefentry>
<refentrytitle>wvtag</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry></para>
<para>
Please visit www.wavpack.com for more information
Expand Down
11 changes: 6 additions & 5 deletions man/wvgain.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: wvgain
.\" Author: Sebastian Dröge <slomo@debian.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 2016-11-13
.\" Date: 2017-01-13
.\" Manual: WavPack Executable Programs
.\" Source: WavPack 5.0.0
.\" Source: WavPack 5.1.0
.\" Language: English
.\"
.TH "WVGAIN" "1" "2016\-11\-13" "WavPack 5\&.0\&.0" "WavPack Executable Programs"
.TH "WVGAIN" "1" "2017\-01\-13" "WavPack 5\&.1\&.0" "WavPack Executable Programs"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down Expand Up @@ -87,7 +87,8 @@ don\*(Aqt set (n = 0 or omitted) or set (n = 1) console title to indicate progre
.SH "SEE ALSO"
.PP
\fBwavpack\fR(1),
\fBwvunpack\fR(1)
\fBwvunpack\fR(1),
\fBwvtag\fR(1)
.PP
Please visit www\&.wavpack\&.com for more information
.SH "COPYRIGHT"
Expand All @@ -113,5 +114,5 @@ Updates
.br
Copyright \(co 2005 Sebastian Dröge
.br
Copyright \(co 2016 David Bryant
Copyright \(co 2017 David Bryant
.br
9 changes: 6 additions & 3 deletions man/wvgain.xml
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@
<holder>Sebastian Dröge</holder>
</copyright>
<copyright>
<year>2016</year>
<year>2017</year>
<holder>David Bryant</holder>
</copyright>
<date>2016-11-13</date>
<date>2017-01-13</date>
</refentryinfo>
<refmeta>
<refentrytitle>wvgain</refentrytitle>
<refmiscinfo class="source">WavPack</refmiscinfo>
<refmiscinfo class="manual">WavPack Executable Programs</refmiscinfo>
<refmiscinfo class="version">5.0.0</refmiscinfo>
<refmiscinfo class="version">5.1.0</refmiscinfo>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
Expand Down Expand Up @@ -108,6 +108,9 @@
</citerefentry>, <citerefentry>
<refentrytitle>wvunpack</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>, <citerefentry>
<refentrytitle>wvtag</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry></para>
<para>
Please visit www.wavpack.com for more information
Expand Down
175 changes: 175 additions & 0 deletions man/wvtag.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
'\" t
.\" Title: wvtag
.\" Author: David Bryant <david@wavpack.com>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 2017-01-13
.\" Manual: WavPack Executable Programs
.\" Source: WavPack 5.1.0
.\" Language: English
.\"
.TH "WVTAG" "1" "2017\-01\-13" "WavPack 5\&.1\&.0" "WavPack Executable Programs"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
wvtag \- metadata utility for wavpack files
.SH "SYNOPSIS"
.HP \w'\fBwvtag\fR\ 'u
\fBwvtag\fR [\fB\fI\-options\fR\fR] \fB\fIINFILE\fR\fR...
.SH "DESCRIPTION"
.PP
\fBwvtag\fR
applies the specified metadata operation(s) to each of the specified WavPack source file(s) in this order: clean, import, delete, write, extract, list\&. Note that WavPack metadata is stored in APEv2 tags, and this tool will automatically import from an ID3v1 tag if it is the only tag present on the source file, and that ID3v1 tag will be deleted and replaced with an APEv2 tag if an edit is requested\&.
.SH "OPTIONS"
.PP
.PP
\fB\-\-allow\-huge\-tags\fR
.RS 4
allow tag data up to 16 MB (embedding > 1 MB is not recommended for portable devices and may not work with some programs including WavPack pre\-4\&.70)
.RE
.PP
\fB\-c\fR
.RS 4
extract cuesheet only to
stdout
(equivalent to
\fB\-x \fR\fB\(lqcuesheet\(rq\fR)
.RE
.PP
\fB\-cc\fR
.RS 4
extract cuesheet to
source\-name\&.cue
file in same directory as source file (equivalent to
\fB\-xx \fR\fB\(lqcuesheet=%a\&.cue\(rq\fR)
.RE
.PP
\fB\-\-clean\fR, \fB\-\-clear\fR
.RS 4
clean all items from tag (done first)
.RE
.PP
\fB\-d \fR\fB\(lq\fIField\fR\(rq\fR
.RS 4
delete specified metadata item (text or binary)
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
this help display
.RE
.PP
\fB\-\-import\-id3\fR
.RS 4
import applicable tag items from ID3v2\&.3 tag present in DSF files into APEv2 tag (if there are > 1 MB cover images present add
\fB\-\-allow\-huge\-tags\fR
to include them)
.RE
.PP
\fB\-l\fR, \fB\-\-list\fR
.RS 4
list all tag items (done last)
.RE
.PP
\fB\-\-no\-utf8\-convert\fR
.RS 4
don\*(Aqt recode passed tags from local encoding to UTF\-8, assume they are in UTF\-8 already
.RE
.PP
\fB\-q\fR
.RS 4
quiet (keep console output to a minimum)
.RE
.PP
\fB\-v\fR, \fB\-\-version\fR
.RS 4
write program version to
stdout
.RE
.PP
\fB\-w \fR\fB\(lq\fIField\fR=\(rq\fR
.RS 4
delete specified metadata item (text or binary)
.RE
.PP
\fB\-w \fR\fB\(lq\fIField\fR=\fIValue\fR\(rq\fR
.RS 4
write specified text metadata to APEv2 tag
.RE
.PP
\fB\-w \fR\fB\(lq\fIField\fR=@\fIfile\&.ext\fR\(rq\fR
.RS 4
write specified text metadata from file to APEv2 tag, normally used for embedded cuesheets and logs (field names
\(lqCuesheet\(rq
and
\(lqLog\(rq)
.RE
.PP
\fB\-\-write\-binary\-tag \fR\fB\(lq\fIField\fR=@\fIfile\&.ext\fR\(rq\fR
.RS 4
write the specified binary metadata file to APEv2 tag, normally used for cover art with the specified field name
\(lqCover Art (Front)\(rq
.RE
.PP
\fB\-x \fR\fB\(lq\fIField\fR\(rq\fR
.RS 4
extract the specified tag field only to
stdout
.RE
.PP
\fB\-xx \fR\fB\(lq\fIField\fR[=\fIfile\fR]\(rq\fR
.RS 4
extract the specified tag field to named file in same directory as source file; optional filename specification may contain
\fB%a\fR
which is replaced with the audio file base name,
\fB%t\fR
replaced with the tag field name (note: comes from data for binary tags) and
\fB%e\fR
replaced with the extension from the binary tag source file (or
\(lqtxt\(rq
for text tag)\&.
.RE
.PP
\fB\-y\fR
.RS 4
yes to all warnings (use with caution!)
.RE
.SH "SEE ALSO"
.PP
\fBwavpack\fR(1),
\fBwvunpack\fR(1),
\fBwvgain\fR(1)
.PP
Please visit www\&.wavpack\&.com for more information
.SH "COPYRIGHT"
.PP
This manual page was written by David Bryant
<david@wavpack\&.com>\&. Permission is granted to copy, distribute and/or modify this document under the terms of the
BSD
License\&.
.SH "AUTHOR"
.PP
\fBDavid Bryant\fR <\&david@wavpack\&.com\&>
.RS 4
Author
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2017 David Bryant
.br
Loading

0 comments on commit 98601d3

Please sign in to comment.