FSS Basic List Write Documentation

The fss_basic_list_write program is a tool for generating strings that follow the FSS-0002 (Basic List) standard.

This tool is designed to be scriptable and accepts piped input using a special format.

This tool shares parameters between with the other FSS Read and Write programs to make scripting consistent across the FSS Read and Write programs even if any given program neither needs nor uses the parameter.

Standard Parameters

Short	Long	Description
`-h`	`--help`	Print the help message.
`+d`	`++dark`	Output using colors that show up better on dark backgrounds.
`+l`	`++light`	Output using colors that show up better on light backgrounds.
`+n`	`++no_color`	Do not print using color.
`+Q`	`++quiet`	Decrease verbosity, silencing most output.
`+E`	`++error`	Decrease verbosity, using only error output.
`+N`	`++normal`	Set verbosity to normal.
`+V`	`++verbose`	Increase verbosity beyond normal output.
`+D`	`++debug`	Enable debugging, significantly increasing verbosity beyond normal output.
`+v`	`++version`	Print only the version number.

The +Q/++quiet parameter silences all output that is not the intent and purpose of the program. For example, the purpose of the utf8 program is to print the Unicode code point or the UTF-8 byte code. The +Q/++quiet will not suppress this output. The new line printed at the end of the program, is however, not printed. The +Q/++quiet is ideal for using in scripting to help guarantee more consistent and controlled output.

The +N/++no_color simplifies the output to avoid the special color character codes. The special color character codes tend to take up a lot of extra space and may slow down printing performance.

Program Parameters

Short	Long	Description
`-c`	`--content`	The Content to write.
`-d`	`--double`	Use double quotes (default).
`-f`	`--file`	Specify a file to send data to.
`-I`	`--ignore`	Ignore a given range within a Content.
`-o`	`--object`	The Object to write.
`-p`	`--partial`	Do not file end of Object/Content character.
`-P`	`--prepend`	Prepend the given white space characters to the start of each multi-line Content.
`-s`	`--single`	Use single quotes.
`-T`	`--trim`	Trim Object names.

This special piped input format uses the ASCII Backspace character '\b' (U+0008), Form Feed character '\f' (U+000C), and Vertical Line character '\v' (U+000B).

The Backspace character '\b' (U+0008) is used to designate the start of a Content.

The Form Feed character '\f' (U+000C) is used to designate the end of the last Content.

The Vertical Line character '\v' (U+000B) is used to ignore a Content range, which does nothing in this program.

For the pipe, an Object is terminated by either a Backspace character '\b' (U+0008) or a Form Feed character '\f' (U+000C). The end of the pipe represents the end of any Object or Content.

The FSS-0002 (Basic List) specification does not support quoted names, therefore the parameters --single and --double do nothing.

This program does not use the parameter --ignore, which therefore does nothing. This parameter requires two values.