$Header: /home/bsd/.CVS/mp-coding/mp-coding.txt,v 1.2 2005/09/27 01:43:16 bsd Exp $

mp-coding - a tool for coding videos using MPlayer

SYNOPSIS
    mp-coding [-v] [-m path-to-monitorcommand] [-c configfile]
	<video> <master-codes-file> <coding-results-file>
	[mplayer-args...]

DESCRIPTION
    mp-coding is a simple tool for coding video files (referring
    to the formal marking or annotation of a video or audio stream)
    with the occurrences of identified events.  Codes are added by
    hitting single keys which are mapped to codes.  Note: Q (shift-q)
    will quit mp-coding.

    The top-level codes (defined in the provided master-codes-file)
    are defined in the provided file.  This file has the following
    format:

	<key> <code-type> <code-name> <help-text> <type-specific info...>

    <key> defines the key bound to this code; it is case sensitive.
    <code-name> will be written to the coding-results.
    <help-text> is shown on the key-list page.
    <code-type> may be one of the following:

	<key> selection <code-name> <help-text> <sublist-filename> <prompt>
	    Prompt for the selection of a list of values taken from
	    <sublist-filename>.  The user can add new selections on
	    the fly.

	<key> prompt <code-name> <help-text> <prompt>
	    Prompt for a string, added to the provided code-name.

	<key> code <code-name> <help-text>
	    Use out the provided code-name.

    Codes are written to the provided file in the following form:

	<time>,<code-name>,<code-paramters...>

    where <time> is the time where the code was made.  This value
    can be provided to MPlayer with the -ss to replay from that
    point.

    While coding, the list of available codes are available by
    pressing '?'.

OPTIONS
    -v  be verbose

    -m path-to-monitorcommand
	monitorcommand(1) is required for monitoring the output of
	MPlayer.  Its location must be specified if it cannot be
	found on the PATH.

    -c configfile
	configfile is a shell script that is executed before the
	commencement of coding.  It is useful for overriding any
	preset values or functions defined by mp-coding.

SEE ALSO
    monitorcommand(1), stty(1)

LICENSE
    Released to the public domain.