Added some more documentation

This commit is contained in:
Jamie Hardt
2020-05-15 18:11:07 -07:00
parent 3718541e09
commit 9bb2ae136a
2 changed files with 22 additions and 8 deletions

View File

@@ -1,16 +1,18 @@
.\" Manpage for ptulsconv
.\" Contact https://github.com/iluvcapra/ptulsconv
.TH ptulsconv 1 "12 Feb 2020" "0.3.3" "ptulsconv man page"
.TH ptulsconv 1 "15 May 2020" "0.4.0" "ptulsconv man page"
.SH NAME
.BR "ptulsconv" " \- convert
.IR "Avid Pro Tools" " text exports"
.SH SYNOPSIS
ptulsconv [OPTIONS] Export.txt
.SH DESCRIPTION
Description
Convert a Pro Tools text export into a flat list of clip names with timecodes. A tagging
language is interpreted to add columns and type the data. The default output format is
an XML file for import into Filemaker Pro.
.SH OPTIONS
.IP "-h, --help"
show a help message and exit
show a help message and exit.
.TP
.RI "-i " "TC"
Don't output events before this timecode, and offset all remaining
@@ -18,7 +20,17 @@ events to start at this timecode.
.TP
.RI "-o " "TC"
Don't output events occurring after this timecode.
.SH SEE ALSO
See Also
.TP
.RI "-m "
Include muted clips.
.TP
.RI "--xform " "NAME"
Convert the output with a built-in output transform.
.TP
.RI "--show-available-tags"
Print a list of tags that are interpreted and exit.
.TP
.RI "--show-available-transforms"
Print a list of built-in output transforms and exit.
.SH AUTHOR
Jamie Hardt (contact at https://github.com/iluvcapra/ptulsconv)

View File

@@ -17,7 +17,10 @@ def main():
# parser.add_option('-P', '--progress', default=False, action='store_true', dest='show_progress',
# help='Show progress bar.')
parser.add_option('-m', '--include-muted', default=False, action='store_true', dest='include_muted',
help='Read muted clips.')
help='Include muted clips.')
parser.add_option('--xform', dest='xslt', help="Convert with built-is XSLT transform.",
default=None, metavar='NAME')
parser.add_option('--show-available-tags', dest='show_tags',
action='store_true',
@@ -27,8 +30,7 @@ def main():
action='store_true',
default=False, help='Display available built-in XSLT transforms.')
parser.add_option('--xform', dest='xslt', help="Convert with built-is XSLT transform.",
default=None, metavar='NAME')
(options, args) = parser.parse_args(sys.argv)
print_banner_style("%s %s (c) 2020 %s. All rights reserved." % (__name__, __version__, __author__))