1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
[comment {-*- tcl -*- doctools manpage}]
[manpage_begin shtmlview n 1.1.0]
[keywords html markdown doctools mkdoc]
[keywords viewer]
[copyright {}]
[titledesc {Basic HTML and Markdown viewer application}]
[moddesc {Basic HTML and Markdown viewer}]
[category {Document display}]
[description]
[para]
The application described by this document, [syscmd shtmlview], is a
simple viewer for HTML files. Further supported are documents written
in [term Markdown], [term doctools], or [term mkdoc] format, if
various supporting packages are available.
See section [sectref {Beyond HTML}].
[subsection {COMMAND LINE}]
[list_begin definitions]
[call [cmd shtmlview]]
[call [cmd shtmlview] [option --help]]
Prints usage information to standard error.
[call [cmd shtmlview] [option --version]]
Prints the application version to standard output.
[call [cmd shtmlview] [option --render] [arg text]]
Displays the provided text in a viewer window.
Treats the text as Markdown except if it starts with a recognized HTML
tag. In that case it assumes and renders as HTML.
[call [cmd shtmlview] [option --render] [const -]]
As before, except it reads the text to render from standard input.
[call [cmd shtmlview] [arg filename]]
Reads and renders the named file in a viewer widget.
[list_end]
[section {Beyond HTML}]
Documents in any other format than HTML require the presence of
various supporting packages to enable the application to display them.
[list_begin definitions]
[def Markdown]
[list_begin itemized]
[item] [package Markdown]
[list_end]
[def doctools]
[list_begin itemized]
[item] [package shtmlview::doctools]
[item] [package dtplite]
[list_end]
[def mkdoc]
[list_begin itemized]
[item] [package shtmlview::mkdoc]
[item] [package mkdoc::mkdoc]
[list_end]
[list_end]
[section {BUGS, IDEAS, FEEDBACK}]
This document, and the application it describes, will undoubtedly
contain bugs and other problems.
Please report such in the category [emph shtmlview] of the
[uri {https://core.tcl-lang.org/tklib/ticket} {Tklib Trackers}].
Please also report any ideas for enhancements you may have for either
application and/or documentation.
[vset CATEGORY shtmlview]
[include ../support/devel/doc/feedback.inc]
[manpage_end]
|
