Skip to content

Commit

Permalink
Add (stub) man pages.
Browse files Browse the repository at this point in the history
  • Loading branch information
PerBothner committed Feb 19, 2017
1 parent 6234284 commit 22f4ce4
Show file tree
Hide file tree
Showing 5 changed files with 95 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ wsclasses.stamp
tmp-for-xul
tmp-for-jar
tmp-repl.in
doc/*.1
doc/index.html
doc/Applications.html
doc/Architecture-notes.html
Expand Down
20 changes: 19 additions & 1 deletion Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,8 @@ run-shell: $(DOMTERM_JAR)

clean-am:
-rm -rf *.stamp tmp-* org/domterm/*.class org/domterm/*/*.class websocketterm/*.class libpty@LIBEXT@ build doc/DomTerm.xml web/*.html $(DOMTERM_JAR) $(WSDOMTERM_JAR) native/pty/*.o native/pty/org_domterm_pty_PTY.h lib/*$(LIBEXT)
-rm -rf bin/ldomterm bin/domterm
-rm -rf bin/ldomterm bin/domterm \
doc/domterm.1 doc/ldomterm.1 doc/qtdomterm.1
@WITH_QTWEBENGINE_TRUE@ cd qtdomterm && $(MAKE) clean
@WITH_QTWEBENGINE_TRUE@ rm -rf bin/qtdomterm
-rm -f qtdomterm/data/hlib/domterm-all.js \
Expand Down Expand Up @@ -302,3 +303,20 @@ else
cd $(DESTDIR)$(bindir) && $(LN_S) jdomterm domterm
endif
endif

man_MANS = doc/domterm.1
if WITH_LIBWEBSOCKETS
man_MANS += doc/ldomterm.1
endif
if WITH_QTWEBENGINE
man_MANS += doc/qtdomterm.1
endif
doc/domterm.1: $(srcdir)/doc/domterm.man
nroff -man $< > tpm-domterm.1
mv tpm-domterm.1 doc/domterm.1
doc/ldomterm.1: $(srcdir)/doc/ldomterm.man
nroff -man $< > tpm-ldomterm.1
mv tpm-ldomterm.1 doc/ldomterm.1
doc/qtdomterm.1: $(srcdir)/doc/qtdomterm.man
nroff -man $< > tpm-qtdomterm.1
mv tpm-qtdomterm.1 doc/qtdomterm.1
26 changes: 26 additions & 0 deletions doc/domterm.man
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.TH LDOMTERM 1
.SH NAME
domterm \- a terminal emulator based on web techologies
.SH SYNOPSIS
.B domterm
.I "[options]"
.I [command argument ...]
.SH "DESCRIPTION"
The domterm command is an alias for either
.BR ldomterm (1)
or
.BR qtdomterm (1).
For more details see those commands.

The domterm application implements a terminal emulator based on
web technologies. This means the displayed text is structured
like a web page, and can include image, links, and annotations.
The style can be changed with CSS style sheets.

.SH SEE ALSO
.BR ldomterm (1)
.BR qtdomterm (1)
.BR qtdomterm(1)
.PP
.BR "http://domterm.org/"
- the DomTerm home page
28 changes: 28 additions & 0 deletions doc/ldomterm.man
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
.TH LDOMTERM 1
.SH NAME
ldomterm \- a terminal emulator based on web techologies
.SH SYNOPSIS
.B ldomterm
.I "[options]"
.I [command argument ...]

.SH "DESCRIPTION"
The ldomterm program implements a terminal emulator based on
web technologies. This means the displayed text is structured
like a web page, and can include image, links, and annotations.
The style can be changed with CSS style sheets.
.PP
The user interface ("DomTerm") and the actual terminal emulator
runs in the "front-end", typically a web browser window.
The ldomterm program starts a WebSockets server, runs the
.I command
(the "back-end"), and then by default creates a front-end
window connected to the back-end.

.SH SEE ALSO
.BR domterm (1)
- an alias for either ldomterm or qtdomterm
.BR qtdomterm(1)
.PP
.BR "http://domterm.org/"
- the DomTerm home page
21 changes: 21 additions & 0 deletions doc/qtdomterm.man
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.TH QTDOMTERM 1
.SH NAME
qtdomterm \- a terminal emulator based on Qt and web techologies
.SH SYNOPSIS
.B qtdomterm
.I "[options]"
.I [command argument ...]

.SH "DESCRIPTION"
The qtdomterm program implements a terminal emulator based on
web technologies. This means the displayed text is structured
like a web page, and can include image, links, and annotations.
The style can be changed with CSS style sheets.

.SH SEE ALSO
.BR domterm (1)
- an alias for either ldomterm or qtdomterm
.BR ldomterm(1)
.PP
.BR "http://domterm.org/"
- the DomTerm home page

0 comments on commit 22f4ce4

Please sign in to comment.