diff options
Diffstat (limited to 'tests/lexers/scdoc')
| -rw-r--r-- | tests/lexers/scdoc/example.txt | 1821 |
1 files changed, 1821 insertions, 0 deletions
diff --git a/tests/lexers/scdoc/example.txt b/tests/lexers/scdoc/example.txt new file mode 100644 index 00000000..9f152af1 --- /dev/null +++ b/tests/lexers/scdoc/example.txt @@ -0,0 +1,1821 @@ +---input--- +scdoc(5) + +# NAME + +scdoc - document format for writing manual pages + +# SYNTAX + +Input files must use the UTF-8 encoding. + +## PREAMBLE + +Each scdoc file must begin with the following preamble: + + *name*(_section_) ["left\_footer" ["center\_header"]] + +*name* is the name of the man page you are writing, and _section_ is the section +you're writing for (see *man*(1) for information on manual sections). + +_left\_footer_ and _center\_header_ are optional arguments which set the text +positioned at those locations in the generated man page, and *must* be +surrounded with double quotes. + +## SECTION HEADERS + +Each section of your man page should begin with something similar to the +following: + + # HEADER NAME + +Subsection headers are also understood - use two hashes. Each header must have +an empty line on either side. + +## PARAGRAPHS + +Begin a new paragraph with an empty line. + +## LINE BREAKS + +Insert a line break by ending a line with \+\+. + +The result looks++ +like this. + +## FORMATTING + +Text can be made *bold* or _underlined_ with asterisks and underscores: \*bold\* +or \_underlined\_. Underscores in the_middle_of_words will be disregarded. + +## INDENTATION + +You may indent lines with tab characters (*\\t*) to indent them by 4 spaces in +the output. Indented lines may not contain headers. + + The result looks something like this. + + You may use multiple lines and most _formatting_. + +Deindent to return to normal, or indent again to increase your indentation +depth. + +## LISTS + +You may start bulleted lists with dashes (-), like so: + +``` +- Item 1 +- Item 2 + - Subitem 1 + - Subitem 2 +- Item 3 +``` + +The result looks like this: + +- Item 1 +- Item 2 + - Subitem 1 + - Subitem 2 +- Item 3 + +You may also extend long entries onto another line by giving it the same indent +level, plus two spaces. They will be rendered as a single list entry. + +``` +- Item 1 is pretty long so let's + break it up onto two lines +- Item 2 is shorter + - But its children can go on + for a while +``` + +- Item 1 is pretty long so let's + break it up onto two lines +- Item 2 is shorter + - But its children can go on + for a while + +## NUMBERED LISTS + +Numbered lists are similar to normal lists, but begin with periods (.) instead +of dashes (-), like so: + +``` +. Item 1 +. Item 2 +. Item 3, + with multiple lines +``` + +. Item 1 +. Item 2 +. Item 3, + with multiple lines + +## TABLES + +To begin a table, add an empty line followed by any number of rows. + +Each line of a table should start with | or : to start a new row or column +respectively (or space to continue the previous cell on multiple lines), +followed by [ or - or ] to align the contents to the left, center, or right, +followed by a space and the contents of that cell. You may use a space instead +of an alignment specifier to inherit the alignment of the same column in the +previous row. + +The first character of the first row is not limited to | and has special +meaning. [ will produce a table with borders around each cell. | will produce a +table with no borders. ] will produce a table with one border around the whole +table. + +To conclude your table, add an empty line after the last row. + +``` +[[ *Foo* +:- _Bar_ +:- +| *Row 1* +: Hello +:] world! +| *Row 2* +: こんにちは +: 世界 + ! +``` + +[[ *Foo* +:- _Bar_ +:- +| *Row 1* +: Hello +:] world! +| *Row 2* +: こんにちは +: 世界 + ! + +## LITERAL TEXT + +You may turn off scdoc formatting and output literal text with escape codes and +literal blocks. Inserting a \\ into your source will cause the subsequent symbol +to be treated as a literal and copied directly to the output. You may also make +blocks of literal syntax like so: + +``` +\``` +_This formatting_ will *not* be interpreted by scdoc. +\``` +``` + +These blocks will be indented one level. Note that literal text is shown +literally in the man viewer - that is, it's not a means for inserting your own +roff macros into the output. Note that \\ is still interpreted within literal +blocks, which for example can be useful to output \``` inside of a literal +block. + +## COMMENTS + +Lines beginning with ; and a space are ignored. + +``` +; This is a comment +``` + +# CONVENTIONS + +By convention, all scdoc documents should be hard wrapped at 80 columns. + +# SEE ALSO + +*scdoc*(1) + +# AUTHORS + +Maintained by Drew DeVault <sir@cmpwn.com>. Up-to-date sources can be found at +https://git.sr.ht/~sircmpwn/scdoc and bugs/patches can be submitted by email to +~sircmpwn/public-inbox@lists.sr.ht. + +---tokens--- +'scdoc(5)' Text +'\n' Text + +'\n' Text + +'#' Generic.Heading +' NAME\n' Text + +'\n' Text + +'scdoc' Text +' ' Text +'-' Text +' ' Text +'document' Text +' ' Text +'format' Text +' ' Text +'for' Text +' ' Text +'writing' Text +' ' Text +'manual' Text +' ' Text +'pages' Text +'\n' Text + +'\n' Text + +'#' Generic.Heading +' SYNTAX\n' Text + +'\n' Text + +'Input' Text +' ' Text +'files' Text +' ' Text +'must' Text +' ' Text +'use' Text +' ' Text +'the' Text +' ' Text +'UTF-8' Text +' ' Text +'encoding.' Text +'\n' Text + +'\n' Text + +'##' Generic.Subheading +' PREAMBLE\n' Text + +'\n' Text + +'Each' Text +' ' Text +'scdoc' Text +' ' Text +'file' Text +' ' Text +'must' Text +' ' Text +'begin' Text +' ' Text +'with' Text +' ' Text +'the' Text +' ' Text +'following' Text +' ' Text +'preamble:' Text +'\n' Text + +'\n' Text + +'\t' Text +'*name*' Generic.Strong +'(' Text +'_section_)' Text +' ' Text +'["left' Text +'\\_' Text +'footer"' Text +' ' Text +'["center' Text +'\\_' Text +'header"]]' Text +'\n' Text + +'\n' Text + +'*name*' Generic.Strong +' ' Text +'is' Text +' ' Text +'the' Text +' ' Text +'name' Text +' ' Text +'of' Text +' ' Text +'the' Text +' ' Text +'man' Text +' ' Text +'page' Text +' ' Text +'you' Text +' ' Text +'are' Text +' ' Text +'writing,' Text +' ' Text +'and' Text +' ' Text +'_section_' Generic.Emph +' ' Text +'is' Text +' ' Text +'the' Text +' ' Text +'section' Text +'\n' Text + +"you're" Text +' ' Text +'writing' Text +' ' Text +'for' Text +' ' Text +'(see' Text +' ' Text +'*man*' Generic.Strong +'(' Text +'1)' Text +' ' Text +'for' Text +' ' Text +'information' Text +' ' Text +'on' Text +' ' Text +'manual' Text +' ' Text +'sections).' Text +'\n' Text + +'\n' Text + +'_left' Text +'\\_' Text +'footer_' Text +' ' Text +'and' Text +' ' Text +'_center' Text +'\\_' Text +'header_' Text +' ' Text +'are' Text +' ' Text +'optional' Text +' ' Text +'arguments' Text +' ' Text +'which' Text +' ' Text +'set' Text +' ' Text +'the' Text +' ' Text +'text' Text +'\n' Text + +'positioned' Text +' ' Text +'at' Text +' ' Text +'those' Text +' ' Text +'locations' Text +' ' Text +'in' Text +' ' Text +'the' Text +' ' Text +'generated' Text +' ' Text +'man' Text +' ' Text +'page,' Text +' ' Text +'and' Text +' ' Text +'*must*' Generic.Strong +' ' Text +'be' Text +'\n' Text + +'surrounded' Text +' ' Text +'with' Text +' ' Text +'double' Text +' ' Text +'quotes.' Text +'\n' Text + +'\n' Text + +'##' Generic.Subheading +' SECTION HEADERS\n' Text + +'\n' Text + +'Each' Text +' ' Text +'section' Text +' ' Text +'of' Text +' ' Text +'your' Text +' ' Text +'man' Text +' ' Text +'page' Text +' ' Text +'should' Text +' ' Text +'begin' Text +' ' Text +'with' Text +' ' Text +'something' Text +' ' Text +'similar' Text +' ' Text +'to' Text +' ' Text +'the' Text +'\n' Text + +'following:' Text +'\n' Text + +'\n' Text + +'\t' Text +'#' Text +' ' Text +'HEADER' Text +' ' Text +'NAME' Text +'\n' Text + +'\n' Text + +'Subsection' Text +' ' Text +'headers' Text +' ' Text +'are' Text +' ' Text +'also' Text +' ' Text +'understood' Text +' ' Text +'-' Text +' ' Text +'use' Text +' ' Text +'two' Text +' ' Text +'hashes.' Text +' ' Text +'Each' Text +' ' Text +'header' Text +' ' Text +'must' Text +' ' Text +'have' Text +'\n' Text + +'an' Text +' ' Text +'empty' Text +' ' Text +'line' Text +' ' Text +'on' Text +' ' Text +'either' Text +' ' Text +'side.' Text +'\n' Text + +'\n' Text + +'##' Generic.Subheading +' PARAGRAPHS\n' Text + +'\n' Text + +'Begin' Text +' ' Text +'a' Text +' ' Text +'new' Text +' ' Text +'paragraph' Text +' ' Text +'with' Text +' ' Text +'an' Text +' ' Text +'empty' Text +' ' Text +'line.' Text +'\n' Text + +'\n' Text + +'##' Generic.Subheading +' LINE BREAKS\n' Text + +'\n' Text + +'Insert' Text +' ' Text +'a' Text +' ' Text +'line' Text +' ' Text +'break' Text +' ' Text +'by' Text +' ' Text +'ending' Text +' ' Text +'a' Text +' ' Text +'line' Text +' ' Text +'with' Text +' ' Text +'\\+' Text +'\\+' Text +'.' Text +'\n' Text + +'\n' Text + +'The' Text +' ' Text +'result' Text +' ' Text +'looks++' Text +'\n' Text + +'like' Text +' ' Text +'this.' Text +'\n' Text + +'\n' Text + +'##' Generic.Subheading +' FORMATTING\n' Text + +'\n' Text + +'Text' Text +' ' Text +'can' Text +' ' Text +'be' Text +' ' Text +'made' Text +' ' Text +'*bold*' Generic.Strong +' ' Text +'or' Text +' ' Text +'_underlined_' Generic.Emph +' ' Text +'with' Text +' ' Text +'asterisks' Text +' ' Text +'and' Text +' ' Text +'underscores:' Text +' ' Text +'\\*' Text +'bold' Text +'\\*' Text +'\n' Text + +'or' Text +' ' Text +'\\_' Text +'underlined' Text +'\\_' Text +'.' Text +' ' Text +'Underscores' Text +' ' Text +'in' Text +' ' Text +'the_middle_of_words' Text +' ' Text +'will' Text +' ' Text +'be' Text +' ' Text +'disregarded.' Text +'\n' Text + +'\n' Text + +'##' Generic.Subheading +' INDENTATION\n' Text + +'\n' Text + +'You' Text +' ' Text +'may' Text +' ' Text +'indent' Text +' ' Text +'lines' Text +' ' Text +'with' Text +' ' Text +'tab' Text +' ' Text +'characters' Text +' ' Text +'(*' Text +'\\\\' Text +'t*)' Text +' ' Text +'to' Text +' ' Text +'indent' Text +' ' Text +'them' Text +' ' Text +'by' Text +' ' Text +'4' Text +' ' Text +'spaces' Text +' ' Text +'in' Text +'\n' Text + +'the' Text +' ' Text +'output.' Text +' ' Text +'Indented' Text +' ' Text +'lines' Text +' ' Text +'may' Text +' ' Text +'not' Text +' ' Text +'contain' Text +' ' Text +'headers.' Text +'\n' Text + +'\n' Text + +'\t' Text +'The' Text +' ' Text +'result' Text +' ' Text +'looks' Text +' ' Text +'something' Text +' ' Text +'like' Text +' ' Text +'this.' Text +'\n' Text + +'\n' Text + +'\t' Text +'You' Text +' ' Text +'may' Text +' ' Text +'use' Text +' ' Text +'multiple' Text +' ' Text +'lines' Text +' ' Text +'and' Text +' ' Text +'most' Text +' ' Text +'_formatting_' Generic.Emph +'.' Text +'\n' Text + +'\n' Text + +'Deindent' Text +' ' Text +'to' Text +' ' Text +'return' Text +' ' Text +'to' Text +' ' Text +'normal,' Text +' ' Text +'or' Text +' ' Text +'indent' Text +' ' Text +'again' Text +' ' Text +'to' Text +' ' Text +'increase' Text +' ' Text +'your' Text +' ' Text +'indentation' Text +'\n' Text + +'depth.' Text +'\n' Text + +'\n' Text + +'##' Generic.Subheading +' LISTS\n' Text + +'\n' Text + +'You' Text +' ' Text +'may' Text +' ' Text +'start' Text +' ' Text +'bulleted' Text +' ' Text +'lists' Text +' ' Text +'with' Text +' ' Text +'dashes' Text +' ' Text +'(-),' Text +' ' Text +'like' Text +' ' Text +'so:' Text +'\n' Text + +'\n' Text + +'```\n' Literal.String + +'- Item 1\n- Item 2\n\t- Subitem 1\n\t- Subitem 2\n- Item 3\n' Text + +'```' Literal.String +'\n' Text + +'\n' Text + +'The' Text +' ' Text +'result' Text +' ' Text +'looks' Text +' ' Text +'like' Text +' ' Text +'this:' Text +'\n' Text + +'\n' Text + +'-' Keyword +' ' Text +'Item' Text +' ' Text +'1' Text +'\n' Text + +'-' Keyword +' ' Text +'Item' Text +' ' Text +'2' Text +'\n' Text + +'\t' Text +'-' Keyword +' ' Text +'Subitem' Text +' ' Text +'1' Text +'\n' Text + +'\t' Text +'-' Keyword +' ' Text +'Subitem' Text +' ' Text +'2' Text +'\n' Text + +'-' Keyword +' ' Text +'Item' Text +' ' Text +'3' Text +'\n' Text + +'\n' Text + +'You' Text +' ' Text +'may' Text +' ' Text +'also' Text +' ' Text +'extend' Text +' ' Text +'long' Text +' ' Text +'entries' Text +' ' Text +'onto' Text +' ' Text +'another' Text +' ' Text +'line' Text +' ' Text +'by' Text +' ' Text +'giving' Text +' ' Text +'it' Text +' ' Text +'the' Text +' ' Text +'same' Text +' ' Text +'indent' Text +'\n' Text + +'level,' Text +' ' Text +'plus' Text +' ' Text +'two' Text +' ' Text +'spaces.' Text +' ' Text +'They' Text +' ' Text +'will' Text +' ' Text +'be' Text +' ' Text +'rendered' Text +' ' Text +'as' Text +' ' Text +'a' Text +' ' Text +'single' Text +' ' Text +'list' Text +' ' Text +'entry.' Text +'\n' Text + +'\n' Text + +'```\n' Literal.String + +"- Item 1 is pretty long so let's\n break it up onto two lines\n- Item 2 is shorter\n\t- But its children can go on\n\t for a while\n" Text + +'```' Literal.String +'\n' Text + +'\n' Text + +'-' Keyword +' ' Text +'Item' Text +' ' Text +'1' Text +' ' Text +'is' Text +' ' Text +'pretty' Text +' ' Text +'long' Text +' ' Text +'so' Text +' ' Text +"let's" Text +'\n' Text + +' ' Text +' ' Text +'break' Text +' ' Text +'it' Text +' ' Text +'up' Text +' ' Text +'onto' Text +' ' Text +'two' Text +' ' Text +'lines' Text +'\n' Text + +'-' Keyword +' ' Text +'Item' Text +' ' Text +'2' Text +' ' Text +'is' Text +' ' Text +'shorter' Text +'\n' Text + +'\t' Text +'-' Keyword +' ' Text +'But' Text +' ' Text +'its' Text +' ' Text +'children' Text +' ' Text +'can' Text +' ' Text +'go' Text +' ' Text +'on' Text +'\n' Text + +'\t' Text +' ' Text +' ' Text +'for' Text +' ' Text +'a' Text +' ' Text +'while' Text +'\n' Text + +'\n' Text + +'##' Generic.Subheading +' NUMBERED LISTS\n' Text + +'\n' Text + +'Numbered' Text +' ' Text +'lists' Text +' ' Text +'are' Text +' ' Text +'similar' Text +' ' Text +'to' Text +' ' Text +'normal' Text +' ' Text +'lists,' Text +' ' Text +'but' Text +' ' Text +'begin' Text +' ' Text +'with' Text +' ' Text +'periods' Text +' ' Text +'(.)' Text +' ' Text +'instead' Text +'\n' Text + +'of' Text +' ' Text +'dashes' Text +' ' Text +'(-),' Text +' ' Text +'like' Text +' ' Text +'so:' Text +'\n' Text + +'\n' Text + +'```\n' Literal.String + +'. Item 1\n. Item 2\n. Item 3,\n with multiple lines\n' Text + +'```' Literal.String +'\n' Text + +'\n' Text + +'.' Text +' ' Text +'Item' Text +' ' Text +'1' Text +'\n' Text + +'.' Text +' ' Text +'Item' Text +' ' Text +'2' Text +'\n' Text + +'.' Text +' ' Text +'Item' Text +' ' Text +'3,' Text +'\n' Text + +' ' Text +' ' Text +'with' Text +' ' Text +'multiple' Text +' ' Text +'lines' Text +'\n' Text + +'\n' Text + +'##' Generic.Subheading +' TABLES\n' Text + +'\n' Text + +'To' Text +' ' Text +'begin' Text +' ' Text +'a' Text +' ' Text +'table,' Text +' ' Text +'add' Text +' ' Text +'an' Text +' ' Text +'empty' Text +' ' Text +'line' Text +' ' Text +'followed' Text +' ' Text +'by' Text +' ' Text +'any' Text +' ' Text +'number' Text +' ' Text +'of' Text +' ' Text +'rows.' Text +'\n' Text + +'\n' Text + +'Each' Text +' ' Text +'line' Text +' ' Text +'of' Text +' ' Text +'a' Text +' ' Text +'table' Text +' ' Text +'should' Text +' ' Text +'start' Text +' ' Text +'with' Text +' ' Text +'|' Text +' ' Text +'or' Text +' ' Text +':' Text +' ' Text +'to' Text +' ' Text +'start' Text +' ' Text +'a' Text +' ' Text +'new' Text +' ' Text +'row' Text +' ' Text +'or' Text +' ' Text +'column' Text +'\n' Text + +'respectively' Text +' ' Text +'(or' Text +' ' Text +'space' Text +' ' Text +'to' Text +' ' Text +'continue' Text +' ' Text +'the' Text +' ' Text +'previous' Text +' ' Text +'cell' Text +' ' Text +'on' Text +' ' Text +'multiple' Text +' ' Text +'lines),' Text +'\n' Text + +'followed' Text +' ' Text +'by' Text +' ' Text +'[' Text +' ' Text +'or' Text +' ' Text +'-' Text +' ' Text +'or' Text +' ' Text +']' Text +' ' Text +'to' Text +' ' Text +'align' Text +' ' Text +'the' Text +' ' Text +'contents' Text +' ' Text +'to' Text +' ' Text +'the' Text +' ' Text +'left,' Text +' ' Text +'center,' Text +' ' Text +'or' Text +' ' Text +'right,' Text +'\n' Text + +'followed' Text +' ' Text +'by' Text +' ' Text +'a' Text +' ' Text +'space' Text +' ' Text +'and' Text +' ' Text +'the' Text +' ' Text +'contents' Text +' ' Text +'of' Text +' ' Text +'that' Text +' ' Text +'cell.' Text +' ' Text +' ' Text +'You' Text +' ' Text +'may' Text +' ' Text +'use' Text +' ' Text +'a' Text +' ' Text +'space' Text +' ' Text +'instead' Text +'\n' Text + +'of' Text +' ' Text +'an' Text +' ' Text +'alignment' Text +' ' Text +'specifier' Text +' ' Text +'to' Text +' ' Text +'inherit' Text +' ' Text +'the' Text +' ' Text +'alignment' Text +' ' Text +'of' Text +' ' Text +'the' Text +' ' Text +'same' Text +' ' Text +'column' Text +' ' Text +'in' Text +' ' Text +'the' Text +'\n' Text + +'previous' Text +' ' Text +'row.' Text +'\n' Text + +'\n' Text + +'The' Text +' ' Text +'first' Text +' ' Text +'character' Text +' ' Text +'of' Text +' ' Text +'the' Text +' ' Text +'first' Text +' ' Text +'row' Text +' ' Text +'is' Text +' ' Text +'not' Text +' ' Text +'limited' Text +' ' Text +'to' Text +' ' Text +'|' Text +' ' Text +'and' Text +' ' Text +'has' Text +' ' Text +'special' Text +'\n' Text + +'meaning.' Text +' ' Text +'[' Text +' ' Text +'will' Text +' ' Text +'produce' Text +' ' Text +'a' Text +' ' Text +'table' Text +' ' Text +'with' Text +' ' Text +'borders' Text +' ' Text +'around' Text +' ' Text +'each' Text +' ' Text +'cell.' Text +' ' Text +'|' Text +' ' Text +'will' Text +' ' Text +'produce' Text +' ' Text +'a' Text +'\n' Text + +'table' Text +' ' Text +'with' Text +' ' Text +'no' Text +' ' Text +'borders.' Text +' ' Text +']' Text +' ' Text +'will' Text +' ' Text +'produce' Text +' ' Text +'a' Text +' ' Text +'table' Text +' ' Text +'with' Text +' ' Text +'one' Text +' ' Text +'border' Text +' ' Text +'around' Text +' ' Text +'the' Text +' ' Text +'whole' Text +'\n' Text + +'table.' Text +'\n' Text + +'\n' Text + +'To' Text +' ' Text +'conclude' Text +' ' Text +'your' Text +' ' Text +'table,' Text +' ' Text +'add' Text +' ' Text +'an' Text +' ' Text +'empty' Text +' ' Text +'line' Text +' ' Text +'after' Text +' ' Text +'the' Text +' ' Text +'last' Text +' ' Text +'row.' Text +'\n' Text + +'\n' Text + +'```\n' Literal.String + +'[[ *Foo*\n:- _Bar_\n:-\n| *Row 1*\n: Hello\n:] world!\n| *Row 2*\n: こんにちは\n: 世界\n !\n' Text + +'```' Literal.String +'\n' Text + +'\n' Text + +'[[' Text +' ' Text +'*Foo*' Generic.Strong +'\n' Text + +':-' Text +' ' Text +'_Bar_' Generic.Emph +'\n' Text + +':-' Text +'\n' Text + +'|' Text +' ' Text +' ' Text +'*Row 1*' Generic.Strong +'\n' Text + +':' Text +' ' Text +' ' Text +'Hello' Text +'\n' Text + +':]' Text +' ' Text +'world!' Text +'\n' Text + +'|' Text +' ' Text +' ' Text +'*Row 2*' Generic.Strong +'\n' Text + +':' Text +' ' Text +' ' Text +'こんにちは' Text +'\n' Text + +':' Text +' ' Text +' ' Text +'世界' Text +'\n' Text + +' ' Text +' ' Text +' ' Text +'!' Text +'\n' Text + +'\n' Text + +'##' Generic.Subheading +' LITERAL TEXT\n' Text + +'\n' Text + +'You' Text +' ' Text +'may' Text +' ' Text +'turn' Text +' ' Text +'off' Text +' ' Text +'scdoc' Text +' ' Text +'formatting' Text +' ' Text +'and' Text +' ' Text +'output' Text +' ' Text +'literal' Text +' ' Text +'text' Text +' ' Text +'with' Text +' ' Text +'escape' Text +' ' Text +'codes' Text +' ' Text +'and' Text +'\n' Text + +'literal' Text +' ' Text +'blocks.' Text +' ' Text +'Inserting' Text +' ' Text +'a' Text +' ' Text +'\\\\' Text +' ' Text +'into' Text +' ' Text +'your' Text +' ' Text +'source' Text +' ' Text +'will' Text +' ' Text +'cause' Text +' ' Text +'the' Text +' ' Text +'subsequent' Text +' ' Text +'symbol' Text +'\n' Text + +'to' Text +' ' Text +'be' Text +' ' Text +'treated' Text +' ' Text +'as' Text +' ' Text +'a' Text +' ' Text +'literal' Text +' ' Text +'and' Text +' ' Text +'copied' Text +' ' Text +'directly' Text +' ' Text +'to' Text +' ' Text +'the' Text +' ' Text +'output.' Text +' ' Text +'You' Text +' ' Text +'may' Text +' ' Text +'also' Text +' ' Text +'make' Text +'\n' Text + +'blocks' Text +' ' Text +'of' Text +' ' Text +'literal' Text +' ' Text +'syntax' Text +' ' Text +'like' Text +' ' Text +'so:' Text +'\n' Text + +'\n' Text + +'```\n' Literal.String + +'\\```\n_This formatting_ will *not* be interpreted by scdoc.\n\\```\n' Text + +'```' Literal.String +'\n' Text + +'\n' Text + +'These' Text +' ' Text +'blocks' Text +' ' Text +'will' Text +' ' Text +'be' Text +' ' Text +'indented' Text +' ' Text +'one' Text +' ' Text +'level.' Text +' ' Text +'Note' Text +' ' Text +'that' Text +' ' Text +'literal' Text +' ' Text +'text' Text +' ' Text +'is' Text +' ' Text +'shown' Text +'\n' Text + +'literally' Text +' ' Text +'in' Text +' ' Text +'the' Text +' ' Text +'man' Text +' ' Text +'viewer' Text +' ' Text +'-' Text +' ' Text +'that' Text +' ' Text +'is,' Text +' ' Text +"it's" Text +' ' Text +'not' Text +' ' Text +'a' Text +' ' Text +'means' Text +' ' Text +'for' Text +' ' Text +'inserting' Text +' ' Text +'your' Text +' ' Text +'own' Text +'\n' Text + +'roff' Text +' ' Text +'macros' Text +' ' Text +'into' Text +' ' Text +'the' Text +' ' Text +'output.' Text +' ' Text +'Note' Text +' ' Text +'that' Text +' ' Text +'\\\\' Text +' ' Text +'is' Text +' ' Text +'still' Text +' ' Text +'interpreted' Text +' ' Text +'within' Text +' ' Text +'literal' Text +'\n' Text + +'blocks,' Text +' ' Text +'which' Text +' ' Text +'for' Text +' ' Text +'example' Text +' ' Text +'can' Text +' ' Text +'be' Text +' ' Text +'useful' Text +' ' Text +'to' Text +' ' Text +'output' Text +' ' Text +'\\`' Text +'``' Text +' ' Text +'inside' Text +' ' Text +'of' Text +' ' Text +'a' Text +' ' Text +'literal' Text +'\n' Text + +'block.' Text +'\n' Text + +'\n' Text + +'##' Generic.Subheading +' COMMENTS\n' Text + +'\n' Text + +'Lines' Text +' ' Text +'beginning' Text +' ' Text +'with' Text +' ' Text +';' Text +' ' Text +'and' Text +' ' Text +'a' Text +' ' Text +'space' Text +' ' Text +'are' Text +' ' Text +'ignored.' Text +'\n' Text + +'\n' Text + +'```\n' Literal.String + +'; This is a comment\n' Text + +'```' Literal.String +'\n' Text + +'\n' Text + +'#' Generic.Heading +' CONVENTIONS\n' Text + +'\n' Text + +'By' Text +' ' Text +'convention,' Text +' ' Text +'all' Text +' ' Text +'scdoc' Text +' ' Text +'documents' Text +' ' Text +'should' Text +' ' Text +'be' Text +' ' Text +'hard' Text +' ' Text +'wrapped' Text +' ' Text +'at' Text +' ' Text +'80' Text +' ' Text +'columns.' Text +'\n' Text + +'\n' Text + +'#' Generic.Heading +' SEE ALSO\n' Text + +'\n' Text + +'*scdoc*' Generic.Strong +'(' Text +'1)' Text +'\n' Text + +'\n' Text + +'#' Generic.Heading +' AUTHORS\n' Text + +'\n' Text + +'Maintained' Text +' ' Text +'by' Text +' ' Text +'Drew' Text +' ' Text +'DeVault' Text +' ' Text +'<sir@cmpwn.com>.' Text +' ' Text +'Up-to-date' Text +' ' Text +'sources' Text +' ' Text +'can' Text +' ' Text +'be' Text +' ' Text +'found' Text +' ' Text +'at' Text +'\n' Text + +'https://git.sr.ht/~sircmpwn/scdoc' Text +' ' Text +'and' Text +' ' Text +'bugs/patches' Text +' ' Text +'can' Text +' ' Text +'be' Text +' ' Text +'submitted' Text +' ' Text +'by' Text +' ' Text +'email' Text +' ' Text +'to' Text +'\n' Text + +'~sircmpwn/public-inbox@lists.sr.ht.' Text +'\n' Text |
