Content-type: text/html; charset=UTF-8 Man page of vorbistags

vorbistags

Section: User Commands (1)
Updated: 27 Feb 2011
Index Return to Main Contents
 

NAME

vorbistags - print and format some info about Ogg Vorbis files  

SYNOPSIS

vorbistags [-e|-e1|-e2|-e3] [-R] [-f format] [-h] [-V] [file...]  

DESCRIPTION

The vorbistags command prints either the list of tags in each of the given Ogg Vorbis files, or specific information about each file according to the given format string. It can escape special characters in ways suitable for CSV (Comma-Separated Values) or TSV (Tab-Separated Values) files.

If there are no file arguments, vorbistags reads from standard input. A file name of "-" (a single dash) also causes vorbistags to read from standard input.

If compiled with iconv support, vorbistags tries to honor the locale setting, outputting any values in the local encoding. Use -R to suppress the encoding and output the values in their raw format (i.e., UTF-8).  

OPTIONS

--escapes

-e
Escapes carriage returns, line feeds and backslashes that occur in the values of the tags (as \r, \n and \\, respectively), so that each tag is printed unambiguously and on a single line.
--escapes=1

-e1
The digit after the option specifies additional levels of escaping. Level 1 also escapes tab characters, viz., as \t. This is useful if vorbistags is used to produce tab-separated output.
--escapes=2

-e2
This causes double quotes to be doubled, i.e., they are output as "". This is useful if vorbistags is used to produce comma-separated values (CSV).
--escapes=3

-e3
Level 3 combines the above two combined and enables all escapes: carriage returns (\r), newlines (\n), backslashes (\\), tabs (\t) and double quotes ("").
The effect of other numbers than 1, 2 and 3 is undefined.
--raw

-R
Raw UTF-8 output. Without this option, the tags from the files are converted to display correctly in the environment ("locale") in which the program is run. If that environment cannot display all characters, they are approximated. With the --raw option, the tags (which are encoded in UTF-8 in the Ogg Vorbis files) are output without conversion. This is especially useful for scripts, to ensure that no information is lost.
--format format

-f format
If this option is used, the normal output of a list of tags and values is suppressed and the format string is printed instead, once for each file argument.
The format string can contain literal characters, but also variables and escape sequences, which are expanded on printing. Variables can either be written %{tagname} or %x where x is a single letter. Examples are %{TITLE}, %{TRACKNUMBER}, %F and %k. See below for the full list of 1-letter variables and escape sequences.
--help

-h
Shows a brief explanation of the command line options.
--version

-V
Shows the version number of the program and exits without processing any files.
 

Substitutions

%fFilename without the path [string]
%FFilename with the path [string]
%kFile size in KB [integer]
%aARTIST [string]
%cDESCRIPTION [string]
%gGENRE [string]
%lALBUM [string]
%nTRACKNUMBER [integer]
%tTITLE [string]
%yDATE [string]
%CCOPYRIGHT [string]
%LVorbis version [string]
%OSOURCEMEDIA [string]
%o number of channels, 1 = mono, 2 = stereo [integer]
%vSame as %L [string]
%QSampling frequency in Hz [integer]
%qSampling frequency in kHz [float]
%rBit rate in kbps [float]
%mPlaying time: minutes only [integer]
%s Playing time: seconds only [float] (used with %m)
%STotal playing time in seconds [float]
%%A single percent sign
 

Escape sequences

\nNewline
\tHorizontal tab
\vVertical tab
\bBackspace
\rCarriage Return
\fForm Feed
\aAudible Alert (terminal bell)
\xhh Any arbitrary character specified by the hexidecimal number hh
\ooo Any arbitrary character specified by the octal number ooo
\\A single backslash character
 

BUGS

The mp3info(1) command also has the following escapes, which are not supported by vorbistags: %G (Musical genre number), %e (Emphasis), %E (CRC Error protection), %p (Padding), %u (Number of good audio frames) and %b (Number of corrupt audio frames).  

EXAMPLE

The following prints all artists and titles of the files given as arguments, in two columns separated by a tab:

vorbistags -f '%{ARTIST}\t%{TITLE}\n' *.ogg

The following is the same, but using 1-letter variables:

vorbistags -f '%a\t%t\n' *.ogg

The following prints the file name and bitrate of each of the matching files:

vorbistags -f 'The bitrate of %F is %r kb/s\n' *.ogg

 

SEE ALSO

vorbiscomment(1), mp3info(1)


 

Index

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
Substitutions
Escape sequences
BUGS
EXAMPLE
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 23:27:13 GMT, May 24, 2016