-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
179 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| .\" Automatically generated by Pandoc 2.9.2.1 | ||
| .\" | ||
| .TH "scripttool" "1" "Augest 4, 2022" "scripttool user manual" "" | ||
| .hy | ||
| .SH NAME | ||
| .PP | ||
| scripttool | ||
| .SH SYNOPSIS | ||
| .PP | ||
| scripttool [-help,-version,-license] VERB OPTIONS [VERB PARAMETERS] | ||
| .SH DESCRIPTION | ||
| .PP | ||
| \f[I]scripttool\f[R] a program for converting between screenplay formats | ||
| (e.g.\ .fdx, .fadein, .fountain) | ||
| .PP | ||
| \f[I]scripttool\f[R] converts screen play file formats. | ||
| Supported formats include FileDraft\[cq]s XML format, FadeIn\[cq]s | ||
| zipped XML format, Fountain formatted plain text as the Open Screenplay | ||
| Format XML documents. | ||
| The command line program is based on a Go package also called | ||
| scripttool. | ||
| The Go package can be compiled to a shared library and integrated with | ||
| Python via the ctypes package. | ||
| .PP | ||
| Internally \f[I]scripttool\f[R] works with Fountain formatter files for | ||
| reporting purposes. | ||
| You can use the \f[C]fountain2json\f[R] verb to see the data structure | ||
| represented as JSON for reports. | ||
| .SH verbs | ||
| .PP | ||
| Like many recent command line tools running under POSIX | ||
| \f[I]scripttool\f[R] uses a | ||
| \f[C]CMD VERB [INPUT_FILENAME] [OUTPUT_FILENAME]\f[R] scheme. | ||
| The follownig verbs are provided. | ||
| Each \[lq]verb\[rq] may also have related options. | ||
| .SS Convert FadeIn files | ||
| .TP | ||
| fadein2fdx | ||
| Converts a FadeIn file to Final Draft XML | ||
| .TP | ||
| fadein2fountain | ||
| Converts a FadeIn file to fountain screenplay format | ||
| .TP | ||
| fadein2json | ||
| Convert a FadeIn file to JSON format | ||
| .TP | ||
| fadein2osf | ||
| Convert a FadeIn file to Open Screenplay Format 2.0 | ||
| .SS Convert Final Draft XML | ||
| .TP | ||
| fdx2fadein | ||
| Convert from Final Draft XML (\[dq]*.fdx\[dq] files) to FadeIn format | ||
| .TP | ||
| fdx2fountain | ||
| Convert from Final Draft XML (\[dq]*.fdx\[dq] files) to Fountain | ||
| screenplay format) | ||
| .TP | ||
| fdx2json | ||
| Convert from Final Draft XML (\[dq]*.fdx\[dq] files) to JSON | ||
| .TP | ||
| fdx2osf | ||
| Convert from Final Draft XML (\[dq]*.fdx\[dq] files) to Open Screenplay | ||
| Format 2.0 | ||
| .SS Convert Open Screenplay Format 2.0 | ||
| .TP | ||
| osf2fadein | ||
| Convert from Open Screenplay Format 2.0 to FadeIn | ||
| .TP | ||
| osf2fdx | ||
| Convert from Open Screenplay Format 2.0 to Final Draft XML | ||
| .TP | ||
| osf2fountain | ||
| Convert from Open Screenplay Format 2.0 to Fountain screenplay format | ||
| .TP | ||
| osf2json | ||
| Convert from Open Screenplay Format 2.0 to JSON | ||
| .SS Convert Fountain fomat | ||
| .TP | ||
| fountain2fadein | ||
| Converts a fountain screenplay formatted file to FadeIn formatted file. | ||
| .TP | ||
| fountain2fdx | ||
| Convert a Fountain screenplay formatted file to Final Draft XML | ||
| .TP | ||
| fountain2json | ||
| Convert a Fountain screenplay formatted file to JSON | ||
| .TP | ||
| fountain2osf | ||
| Convert a Fountain screenplay formatted file to Open Screenplay Format | ||
| 2.0 | ||
| .TP | ||
| fountainfmt | ||
| Pretty print a fountain screenplay format | ||
| .TP | ||
| characters | ||
| Provide a character list from a fountain formatted file. | ||
| Internally the fountain file is parse and resulting JSON structure is | ||
| analyzed to produce the count of character references in the elements of | ||
| the file. | ||
| .SH OPTIONS | ||
| .PP | ||
| Below are a set of options available. | ||
| .TP | ||
| -help | ||
| display help | ||
| .TP | ||
| -license | ||
| display license | ||
| .TP | ||
| -version | ||
| display version number | ||
| .SH VERB OPTIONS | ||
| .TP | ||
| -i | ||
| set input filename | ||
| .TP | ||
| -o | ||
| set output filename | ||
| .TP | ||
| -notes | ||
| include notes in output | ||
| .TP | ||
| -synopsis | ||
| include synopsis in output | ||
| .TP | ||
| -section | ||
| include section headings in output | ||
| .TP | ||
| -width | ||
| set max width in integers | ||
| .TP | ||
| -html | ||
| output full HTML page | ||
| .TP | ||
| -inline-css | ||
| include inline CSS (works with -html option) | ||
| .TP | ||
| -link-css | ||
| include CSS link (works with -html option) | ||
| .TP | ||
| -pretty | ||
| pretty print output | ||
| .TP | ||
| -alpha | ||
| sort characters alphabetically instead of appearence order | ||
| .SH EXAMPLES | ||
| .PP | ||
| Converting \f[I]screenplay.fdx\f[R] to \f[I]screenplay.fountain\f[R] (2 | ||
| examples) | ||
| .IP | ||
| .nf | ||
| \f[C] | ||
| scripttool fdx2fountain screenplay.fdx screenplay.fountain | ||
| scripttool fdx2fountain -i screenplay.fdx -o screenplay.fountain | ||
| \f[R] | ||
| .fi | ||
| .PP | ||
| Converting \f[I]screenplay.fountain\f[R] to \f[I]screenplay.fdx\f[R] (2 | ||
| examples) | ||
| .IP | ||
| .nf | ||
| \f[C] | ||
| scripttool fountain2fdx screenplay.fountain screenplay.fdx | ||
| scripttool fountain2fdx -i screenplay.fountain -o screenplay.fdx | ||
| \f[R] | ||
| .fi | ||
| .PP | ||
| Listing characters from a \f[I]screenplay.fountain\f[R]. | ||
| First list is order of appearence and the second set is characters | ||
| sorted alphabetically using the \[lq]-alpha\[rq] option. | ||
| .IP | ||
| .nf | ||
| \f[C] | ||
| scripttool characters screenplay.fountain | ||
| scripttool characters -alpha screenplay.fountain | ||
| \f[R] | ||
| .fi | ||
| .SH AUTHORS | ||
| R. S. Doiel. |