soxi.1

   1 '\" t
   2 '\" The line above instructs most `man' programs to invoke tbl
   3 '\"
   4 '\" Separate paragraphs; not the same as PP which resets indent level.
   5 .de SP
   6 .if t .sp .5
   7 .if n .sp
   8 ..
   9 '\"
  10 '\" Replacement em-dash for nroff (default is too short).
  11 .ie n .ds m " -
  12 .el .ds m \(em
  13 '\"
  14 '\" Placeholder macro for if longer nroff arrow is needed.
  15 .ds RA \(->
  16 '\"
  17 '\" Decimal point set slightly raised
  18 .if t .ds d \v'-.15m'.\v'+.15m'
  19 .if n .ds d .
  20 '\"
  21 '\" Enclosure macro for examples
  22 .de EX
  23 .SP
  24 .nf
  25 .ft CW
  26 ..
  27 .de EE
  28 .ft R
  29 .SP
  30 .fi
  31 ..
  32 .TH SoXI 1 "February 1, 2013" "soxi" "Sound eXchange"
  33 .SH NAME
  34 SoXI \- Sound eXchange Information, display sound file metadata
  35 .SH SYNOPSIS
  36 \fBsoxi\fR [\fB\-V\fR[\fIlevel\fR]] [\fB\-T\fR] [\fB\-t\fR\^|\^\fB\-r\fR\^|\^\fB\-c\fR\^|\^\fB\-s\fR\^|\^\fB\-d\fR\^|\^\fB\-D\fR\^|\^\fB\-b\fR\^|\^\fB\-B\fR\^|\^\fB\-p\fR\^|\^\fB\-e\fR\^|\^\fB\-a\fR] \fIinfile1\fR ...
  37 .SH DESCRIPTION
  38 Displays information from the header of a given audio file or files.
  39 Supported audio file types are listed and described in
  40 .BR soxformat (7).
  41 Note however, that
  42 .B soxi
  43 is intended for use only with audio files with a self-describing header.
  44 .SP
  45 By default, as much information as is available is shown.
  46 An option may be given to select just a single piece of information
  47 (perhaps for use in a script or batch-file).
  48 .SH OPTIONS
  49 .TP
  50 \fB\-V\fR
  51 Set verbosity. See
  52 .BR sox (1)
  53 for details.
  54 .TP
  55 \fB\-T\fR
  56 Used with multiple files; changes the behaviour of
  57 .BR \-s ,
  58 .B \-d
  59 and
  60 .B \-D
  61 to display the total across all given files.
  62 Note that when used with
  63 .B \-s
  64 with files with different sampling rates, this is of questionable value.
  65 .TP
  66 \fB\-t\fR
  67 Show detected file-type.
  68 .TP
  69 \fB\-r\fR
  70 Show sample-rate.
  71 .TP
  72 \fB\-c\fR
  73 Show number of channels.
  74 .TP
  75 \fB\-s\fR
  76 Show number of samples (0 if unavailable).
  77 .TP
  78 \fB\-d\fR
  79 Show duration in hours, minutes and seconds (0 if unavailable).
  80 Equivalent to number of samples divided by the sample-rate.
  81 .TP
  82 \fB\-D\fR
  83 Show duration in seconds (0 if unavailable).
  84 .TP
  85 \fB\-b\fR
  86 Show number of bits per sample (0 if not applicable).
  87 .TP
  88 \fB\-B\fR
  89 Show the bitrate averaged over the whole file (0 if unavailable).
  90 .TP
  91 \fB\-p\fR
  92 Show estimated sample precision in bits.
  93 .TP
  94 \fB\-e\fR
  95 Show the name of the audio encoding.
  96 .TP
  97 \fB\-a\fR
  98 Show file comments (annotations) if available.
  99 .SH BUGS
 100 Please report any bugs found in this version of SoX to the mailing list
 101 (sox-users@lists.sourceforge.net).
 102 .SH SEE ALSO
 103 .BR sox (1),
 104 .BR soxformat (7),
 105 .BR libsox (3)
 106 .SP
 107 The SoX web site at http://sox.sourceforge.net
 108 .SH LICENSE
 109 Copyright 2008\-2013 by Chris Bagwell and SoX Contributors.
 110 .SP
 111 This program is free software; you can redistribute it and/or modify
 112 it under the terms of the GNU General Public License as published by
 113 the Free Software Foundation; either version 2, or (at your option)
 114 any later version.
 115 .SP
 116 This program is distributed in the hope that it will be useful,
 117 but WITHOUT ANY WARRANTY; without even the implied warranty of
 118 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 119 GNU General Public License for more details.
 120 .SH AUTHORS
 121 Chris Bagwell (cbagwell@users.sourceforge.net).
 122 Other authors and contributors are listed in the ChangeLog file that
 123 is distributed with the source code.