Command Line Parameters and Configuration Files

A program like m3w can be configured to fit many different situations by means of parameters. A complete list of the different parameters appears below. There are many different ways to specify a value for a parameter: It can receive a default value, it can receive a value from the command line, it can get a value from a configuration file, or it can be set in a Dialog Window.

This is the complete sequence of actions:

1. When the program starts, all parameters are assigned a default value.
2. If a file named default.m3w exists in the same directory as the file m3w.exe, this file is read in as a (global) configuration file assigning new values to some or all parameters.
3. If a file default.m3w exists in the current working directory, this file is read in as a (local) configuration file assigning again new values to some or all parameters.
4. Parameter values given on the command line are assigned in the given order from left to right.
5. If one of the command line parameters is a configuration file, this file again is read at exactly the position given in the command line. Subsequent parameter settings on the commandline will overwrite settings in this configuration file.
6. As a special case, m3w can be started by double clicking on a configuration file in the windows explorer. In this case, this configuration file is passed to m3w as a command line argument and m3w will read it as specified in 5.
7. Once the program runs, the File Menu can be used to Open a configuration file and assign parameter values.
8. Configuration files can be dropped onto m3w. This will cause the configuration file to be read, assign parameter values similar to the Open File Menu entry.
9. Finally, using the different Dialog Windows accessible through the Options Menu, parameter values can be changed directly.

Now here is a list of all the parameters, their names, their significance, and their admissible values. For a more detailed description of the meaning of all these options, consult the appropriate section on Dialog Windows. Some Parameters, like for example the soundcard or the genre of an ID3 tag, have as a value a number which is just some internal quantity. The best way to find out what the appropriate number will be is to use the m3w program and the dialog windows to set the parameter to the desired value and then store the setting in a configuration file. This, by the way, is the reason why these internal quantities are included among the command line parameters: to be able to save all the settings, be it as a commandline or a configuration file, and restart m3w at a later time with exactly the same settings.

Notice that for all parameters there are two names, a short one and a long one. The long one is used in configuration files and, if used on the command line must be prefixed by two hyphens, the short one can be used only on the command line and is then preceded by a single hyphen.

• Name: server short: s
  Description: The server where to send the request.
  See also: Broadcast Dialog
  Value: any string, Default: localhost
  Example:
  m3w -s nonexistent.yahoo.com
m3w --server sound.alternative.de

• Name: port short: p
  Description: The port where to send the request.
  See also: Broadcast Dialog
  Value: a number Default: 8000
  Example:
  m3w -p 8000
m3w --port 8001

• Name: mountpoint short: m
  Description: The mountpoint where to mount the stream.
  See also: Broadcast Dialog
  Value: any string, Default: live
  Example:
  m3w -m dietcoke
m3w --mountpoint fanta

• Name: password short: P
  Description: The password needed to convince the server to let you connect.
  See also: Broadcast Dialog
  Value: any string, Default: topsecret
  Example:
  m3w -P 1Uif56juTt(good password)
  m3w --password Marilyn(bad password)

• Name: user short: F
  Description: The user name for logging in to the server.
  See also: Broadcast Dialog
  Value: any string Default: source
  Example:
  m3w -F source
m3w --user cnn

• Name: logintype short: C
  Description: The type of login protocol to use.
  See also: Broadcast Dialog
  Value: 0 for x-audio, 1 for icy, 2 for http, and 3 for udp Default: 0
  Example:
  m3w -C 1
m3w --logintype 2

• Name: private
  Description: restricts access to the stream (not public).
  See also: Broadcast Dialog
  Default: off
  Example:
  m3w --private

• Name: autoreconnect short: X
  Description: Enable the autoreconnect feature.
  See also: Broadcast Dialog
  Default: off (disabled)
  Example:
  m3w -X
m3w --autoreconnect

• Name: rcidelay
  Description: The initial reconnect delay.
  See also: Broadcast Dialog
  Value: seconds Default: 60
  Example:
  m3w --rcidelay 0

• Name: rcdelay
  Description: The delay between two reconnect attempts.
  See also: Broadcast Dialog
  Value: seconds Default: 60
  Example:
  m3w --rcdely 360

• Name: rccount
  Description: The maximum number of unsuccessful reconnect attempts.
  See also: Broadcast Dialog
  Value: a number Default: 3
  Example:
  m3w --rccount 100000

• Name: bitrate short: B
  Description: The bitrate of the encoder, (constant or average)
  See also: Encoder Dialog
  Value: number Default: 46000
  Example:
  m3w -B 1280000
m3w --bitrate 56000

• Name: min
  Description: The minimum bitrate of the encoder, (average)
  See also: Encoder Dialog
  Value: number Default: 0 (let Lame choose a good value)
  Example:
  m3w --min 24000

• Name: max
  Description: The maximum bitrate of the encoder, (average)
  See also: Encoder Dialog
  Value: number Default: 0 (let Lame choose a good value)
  Example:
  m3w --max 128000

• Name: bitmode short: M
  Description: set the encoder bitrate mode (0=average, 1=variable, 2=constant, 3=preset)
  See also: Encoder Dialog
  Default: 0
  Example:
  m3w -M 2
m3w --bitmode 1

• Name: append
  Description: set to append output files.
  See also: Output File
  Default: on
  Example:
  m3w --append

• Name: autoname
  Description: set to create automatic filenames for recording in the format yyyy-mm-dd-hh-mm-ss.mp3.
  See also: Output File
  Default: off
  Example:
  m3w --autoname

• Name: autosave
  Description: set to automaticaly save recordings to files in regular intervals.
  See also: Recording Dialog
  Default: off
  Example:
  m3w --autosave

• Name: autosavetime
  Description: specifies the interval in minutes between auto saving recordings
  See also: Recording Dialog
  Value: number Default: 60
  Example:
  m3w --autosavetime 120

• Name: absolute
  Description: set to count intervals for auto saving from midnight instead of the start of recording.
  See also: Recording Dialog
  Default: off
  Example:
  m3w --absolute

• Name: overwrite
  Description: set to overwrite output files.
  See also: Output File
  Default: off
  Example:
  m3w --overwrite

• Name: presetvalue
  Description: identifies the preset used if preset is switched on (see preset)
  See also: Encoder Dialog
  Value: number Default: 5000
  Example:
  m3w --presetvalue 6000

• Name: name short: n
  Description: the stream name.
  See also: Broadcast Dialog
  Value: any string Default: none
  Example:
  m3w -n "pepsi cola is the best"
  m3w --name "just kidding"

• Name: genre
  Description: the stream genre.
  See also: Broadcast Dialog
  Value: any string Default: none
  Example:
  m3w --genre top

• Name: url
  Description: the place where to get further information on the web.
  See also: Broadcast Dialog
  Value: any string Default: none
  Example:
  m3w --url http://localhost

• Name: description short: D
  Description: a description of the stream content.
  See also: Broadcast Dialog
  Value: any string Default: none
  Example:
  m3w -D "top of the line"
m3w --description crap

• Name: remotedump short: d
  Description: filename for a remote dump.
  See also: Broadcast Dialog
  Value: filename Default: none
  Example:
  m3w -d backup/all.mp3
m3w --remotedump /dev/null

• Name: recordfile short: r
  Description: filename for a local recording
  See also: Output File
  Value: filename Default: none
  Example:
  m3w -r C:\\Temp\record.mp3
m3w --recordfile A:\\test.mp3

• Name: inbuffer
  Description: maximum time to buffer soundcard
  See also: Soundcard Dialog
  Value: seconds Default: 5
  Example:
  m3w --inbuffer 3600

• Name: outbuffer short: o
  Description: maximum time to buffer network.
  See also: Broadcast Dialog
  Value: seconds Default: 5
  Example:
  m3w -o 10
m3w --outbuffer 120

• Name: copyflag short: c
  Description: set flag to mark copies.
  See also: Encoder Dialog
  Default: off
  Example:
  m3w -c
m3w --copyflag

• Name: crcflag
  Description: set flag to generate crc.
  See also: Encoder Dialog
  Default: off
  Example:
  m3w --crcflag

• Name: copyright
  Description: set flag to indicate copyright.
  See also: Encoder Dialog
  Default: off
  Example:
  m3w --copyright

• Name: downsampleflag
  Description: set flag to disable downsampling.
  See also: Encoder Dialog
  Default: off
  Example:
  m3w --downsampleflag

• Name: reservoirflag
  Description: set flag to disable bitreservoir.
  See also: Encoder Dialog
  Default: off
  Example:
  m3w --reservoirflag

• Name: quality short: q
  Description: the variable bitrate target quality value.
  See also: Encoder Dialog
  Value: 0-9 Default: 5
  Example:
  m3w -q 2
m3w --quality 8

• Name: encoderquality short: E
  Description: the encoder quality value.
  See also: Encoder Dialog
  Value: 0-9 Default: 2
  Example:
  m3w -E 2
m3w --encoderquality 7

• Name: stereo short: t
  Description: set flag to choose true stereo.
  See also: Encoder Dialog
  Default: off
  Example:
  m3w -t
m3w --stereo

• Name: tagyear short: Y
  Description: the ID3 Tag year.
  See also: ID3 Tag Dialog
  Value: number Default: 2000
  Example:
  m3w -Y 1866
m3w --tagyear 2001

• Name: tagtrack short: T
  Description: the ID3 Tag track.
  See also: ID3 Tag Dialog
  Value: number Default: 0
  Example:
  m3w -T 49
m3w --tagtrack 2

• Name: taggenre short: G
  Description: the ID3 Tag genre.
  See also: ID3 Tag Dialog
  Value: number Default: 12
  Example:
  m3w -G 7some internal number use m3w to set it
  m3w --taggenre 22same

• Name: tagtitle short: H
  Description: the ID3 Tag title.
  See also: ID3 Tag Dialog
  Value: string Default: none
  Example: ID3 Tag Dialog
  m3w -H "Sinfonie No. 9"
m3w --tagtitle "Serenade in b"

• Name: tagartist short: A
  Description: the ID3 Tag artist.
  See also: ID3 Tag Dialog
  Value: string Default: none
  Example:
  m3w -A "Mickey Mouse"
m3w --tagartist "Donald Guess-Who"

• Name: tagalbum short: U
  Description: the ID3 Tag album.
  See also: ID3 Tag Dialog
  Value: string Default: none
  Example:
  m3w -U "The Best of IT"
m3w --tagalbum "Can't get worse"

• Name: tagcomment short: O
  Description: the ID3 Tag comment.
  See also: ID3 Tag Dialog
  Value: string Default: none
  Example:
  m3w -O "hear me?"
m3w --tagcomment "Listen carefull"

• Name: soundcard short: N
  Description: the soundcard number.
  See also: Soundcard Dialog
  Value: number Default: 0
  Example:
  m3w -N 1
m3w --soundcard 0

• Name: soundformat short: Q
  Description: the sound format number.
  See also: Soundcard Dialog
  Value: Default: 11
  Example:
  m3w -Q 3
m3w --soundformat 5

• Name: inputfile short: I
  Description: the Name of Input File.
  See also: Input Files
  Value: string Default: none
  Example:
  m3w -I pause.mp3
m3w --inputfile all\in\one.mp3

• Name: repeat
  Description: set this flag to start over at the beginning when the input file ends
  See also: Input Files
  Default: off
  Example:
  m3w --repeat

• Name: minimized short: x
  Description: set flag to start m3w minimized in the taskbar.
  See also: Startup Dialog
  Default: off
  Example:
  m3w -x
m3w --minimized

• Name: recording
  Description: set flag to start m3w with recording to output file switched on.
  See also: Startup Dialog, the -r option to specify an output file, the -k and -b options to set the append flag, and the -9 flag to set the autoname flag.
  Default: off
  Example:
  m3w --recording

• Name: broadcasting
  Description: set flag to start m3w with broadcasting switched on.
  See also: Startup Dialog and the -s, -m, -p, and -P options to specify a server.
  Default: off
  Example:
  m3w --broadcasting

• Name: playing
  Description: set flag to start m3w with playing ab input file switched on.
  See also: Startup Dialog and the -I option to specify an input file.
  Default: off
  Example:
  m3w --playing

• Name: listening
  Description: set flag to start m3w with listening to the sound card switched on.
  See also: Startup Dialog and the -N and -Q option to specify the soundcard settings.
  Default: off
  Example:
  m3w --listening

• Name: linearscale
  Description: set flag to switch the meter display to a linear scale
  See also: Volume Control.
  Default: off
  Example:
  m3w --linearscale

• Name: inputscale
  Description: set flag to switch the meter display to the input volume
  See also: Volume Control.
  Default: off
  Example:
  m3w --inputscale

• Name: autogain
  Description: set flag to switch automatic gain control on.
  See also: Soundcard Dialog.
  Default: off
  Example:
  m3w --autogain

• Name: silence short: z
  Description: dB level below which the input signal is considered silence or noise.
  See also: Soundcard Dialog.
  Value: percent Default: -55
  Example:
  m3w --silence -50

• Name: lowlevel
  Description: dB level below which the input signal is considered too low.
  See also: Soundcard Dialog.
  Value: percent Default: -40
  Example:
  m3w --lowlevel -40

• Name: highlevel
  Description: dB level below which the input signal is considered too high.
  See also: Soundcard Dialog.
  Value: percent Default: -6
  Example:
  m3w -J 95
m3w --highlevel 70

• Name: steplevel
  Description: percent step by which the volume level is increased or decreased to correct the input level.
  See also: Soundcard Dialog
  Value: percent Default: 2
  Example:
  m3w --steplevel 8

• Name: noerror
  Description: set flag to replace error pop-up windows by messages in the status line.
  See also: The Options Menu.
  Default: off
  Example:
  m3w --noerror

• Name: detachmeter
  Description: set flag to start with the volume meter in a separate resizable window
  See also: The Options Menu.
  Default: off
  Example:
  m3w --detachmeter

• Name: help short: ?
  Description: give usage information
  Example:
  m3w -?
m3w --help

• Name: configfile short: f
  Description: filename for a configuration file
  Value: filename Default: none
  Example:
  m3w -f default.m3w
m3w --configfile test.txt

  Example Configuration File

  A typical configuration file may look like this:

  
  #m3w configfile: C:\home\m3w\test.m3w  
    
  #the server where to send the request  
  server someplace.some.where.com  
    
  #the port where to send the request  
  port 8000  
    
  #the mountpoint  
  mountpoint global  
    
  #the password  
  password Idontknow  
    
  #to make the stream private  
  #private not set since the leading # makes it a comment  
    
  #the stream bitrate  
  bitrate 96000  
    
  #the stream minimum bitrate  
  min 8000  
    
  #the stream maximum bitrate  
  max 256000  
    
  #the stream name  
  name the stream name  
    
  #the stream genre  
  genre experimental  
    
  #the place where to get information  
  url http://www.info.com  
    
  #a description for the stream  
  description This is the description  
    
  #filename for a remote dump  
  #remotedump /dev/null not set since the leading # makes it a comment  
    
  #filename for a local recording  
  recordfile test.mp3  
    
  #maximum time to buffer soundcard  
  inbuffer 5  
    
  #maximum time to buffer network  
  outbuffer 40