shithub: sox

ref: 23f683ffd5844b88fa352d52d6e441eac6be722e
dir: /play.1/

View raw version
.TH play 1 "December 11, 2001"
.\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
.\" other parms are allowed: see man(7), man(1)
.SH NAME
play, rec \- play and record sound files
.SH SYNOPSIS
.B play
.I "[ general options ] [ format options ] infile1 [ [ format options ] infile2 ... ] [effect]"
.P
.B rec
.I "[ general options ] [format options ] outfile [effect]"
.SH "DESCRIPTION"
.B play
and
.B rec
is a command line front end to the
.B sox(1)
program.  It will play/record audio files to/from unix-style audio devices.  It can optionally apply audio effects to the file.
.PP
When playing audio files, more then one input file can be specified.  If more than one is specified then they are concatenated together while playing.  In this case, it has a restriction that all input files must be of the same data type and sample rates.

When playing audio files without headers, format options may be specified to inform sox of the files sample rate, data size and encoding, and number of channels.  When recording audio data, this same information needs to be presented so that the audio device can be placed into the proper mode.

.SH GENERAL OPTIONS
A summary of general options are included below.  They should only be specified once on the command line.
For a complete description of options and their values, see 
the 
.B sox(1) 
man page.
.TP
.B \-d [device], \-\-device=[device]
Specify a different device to play/record the sound file to/from.
.TP
.B \-h, \-\-help
Show summary of options.
.TP
.B \-V, \-\-verbose
Print verbose information during processing
.TP
.B \-\-version
Show version of play/rec.
.SH FORMAT OPTIONS
A summary of format options are included below.  These options apply to the filename they immediately preceed.
For a complete description of options and their values, see 
the 
.B sox(1) 
man page.
.TP
.B \-c [channels], \-\-channels=[channels]
Define the number of channels in the file.
.TP
.B \-\-file=[filename]
Specify the filename.
.TP
.B \-f [format], \-\-format=[format]
Specify bit format of the sample. One of s, u, U, A, a, or g.
.TP
.B \-r [rate], \-\-rate=[rate]
Specify the sample rate of the audio data (samples per second).
.TP
.B \-s [size], \-\-size=[size]
Specify the width of each sample.  One of b, w, l, f, d, or D.
.TP
.B \-t [type], \-\-type=[type]
Specify audio file format to use.  Useful if it can not be 
automatically determined.
.TP
.B \-v [volume], \-\-volume=[volume]
Change the audio volume
.TP
.B \-x , \-\-xinu
Reverse the byte order of the sample (only works with 16 and 32-bit data).
.TP
Description of effects are described in the 
.B sox(1) 
man page.
.SH EFFECTS
For a complete description of effects and their values, see 
the 
.B sox(1) 
man page.
.SH "SEE ALSO"

sox(1)
soxexam(1)

.SH AUTHOR
This manual page was written by Guenter Geiger <geiger@iem.mhsg.ac.at>,
for the Debian GNU/Linux system.  
.P
Updates by Anonymous.