diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 76 | ||||
| -rw-r--r-- | doc/cheat-sheet.mm | 7 | ||||
| -rwxr-xr-x | doc/grosciteco.tes.in (renamed from doc/grosciteco.tes) | 0 | ||||
| -rw-r--r-- | doc/sciteco.1.in | 14 | ||||
| -rw-r--r-- | doc/sciteco.7.template | 5 | ||||
| -rwxr-xr-x | doc/tedoc.tes.in (renamed from doc/tedoc.tes) | 0 |
6 files changed, 51 insertions, 51 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 9929099..f5b3d03 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -7,21 +7,20 @@ include $(top_srcdir)/bootstrap.am # code. # It generates Troff manpage markup and acts as a Troff # preprocessor to manpage templates. -dist_bin_SCRIPTS = tedoc.tes - -# Name of tedoc.tes after installation, taking --program-prefix -# into account. -TEDOC_INSTALLED = \ - $(bindir)/`echo tedoc.tes | @SED@ '$(transform)'` +bin_SCRIPTS = tedoc.tes +CLEANFILES = tedoc.tes +dist_noinst_SCRIPTS = tedoc.tes.in %.in : %.template tedoc.tes @top_srcdir@/src/*.c - $(SCITECO_FULL) -m -- @srcdir@/tedoc.tes \ + $(SCITECO_FULL) -m -- tedoc.tes \ -C $@ $< @top_srcdir@/src/*.c # grosciteco is a troff postprocessor similar to grotty # which can be used to produce SciTECO-friendly output # (woman pages). -dist_bin_SCRIPTS += grosciteco.tes +bin_SCRIPTS += grosciteco.tes +CLEANFILES += grosciteco.tes +dist_noinst_SCRIPTS += grosciteco.tes.in # grosciteco, like many other postprocessors, works # best with its own macro package. # Unfortunately, there is no way to query the built-in @@ -32,34 +31,24 @@ dist_bin_SCRIPTS += grosciteco.tes # the directory via `groff -M`. dist_scitecodata_DATA = sciteco.tmac -# Name of grosciteco.tes after installation, taking --program-prefix -# into account. -GROSCITECO_INSTALLED = \ - $(bindir)/`echo grosciteco.tes | @SED@ '$(transform)'` - -# Fix up the hash-bang line of installed SciTECO scripts upon -# installation to refer to the installed sciteco binary. -# This takes --program-prefix into account. -# This wouldn't work on Windows since SciTECO cannot open -# the /mingw64 paths. -# -# FIXME: This will patch the hash-bang line repeatedly. -# Perhaps it would be better to do that using a preprocessing -# step before installation - see the known problems that this -# is causing on FreeBSD/Poudriere. -if !WIN32 -install-exec-hook: - $(SCITECO_FULL) -e "<%i^[ :Q[^A^E\\i]:; @EB'^EN[^A^E\\i]' \ - 0,^Q::@FR'#!^EM^Xsciteco'#!$(SCITECO_INSTALLED)'> \ - :EX" \ - $(DESTDIR)$(GROSCITECO_INSTALLED) \ - $(DESTDIR)$(TEDOC_INSTALLED) -endif +# Fix up the hash-bang line of installed SciTECO scripts. +# This takes --prefix and --program-prefix into account. +# On the other hand, since this is run at build time, +# it breaks bindir-overwriting at `make install` time, +# which could only be made to work with an install-exec-hook. +# Patching installed scripts however broke the FreeBSD port +# builds with Poudriere where BINMODE=555 is set. +# It was therefore decided to sacrifice the rarely used +# `make install bindir=...` and appease the FreeBSD port +# committers instead. +%.tes : %.tes.in + $(SCITECO_FULL) -qioe '0,^Q::@FR/#!^EM^Xsciteco/#!^EQ[^A1]/^[' \ + $(SCITECO_INSTALLED) <$< >$@ womendir = $(scitecolibdir)/women women_DATA = grosciteco.tes.1.woman grosciteco.tes.1.woman.tec -CLEANFILES = grosciteco.tes.1 +CLEANFILES += grosciteco.tes.1 EXTRA_DIST = grosciteco.tes.1.in women_DATA += tedoc.tes.1.woman tedoc.tes.1.woman.tec @@ -80,26 +69,21 @@ EXTRA_DIST += tutorial.ms.in CLEANFILES += $(women_DATA) -# Using pattern rules is bugged in some versions of GNU make in -# combination with grouped targets (&:). -define woman_man_rule -$(1).woman $(1).woman.tec &: $(1) sciteco.tmac grosciteco.tes - @GROFF@ @GROFF_FLAGS@ -wall -Z -Tutf8 -t -man -M@srcdir@ -msciteco $$< | \ - $(SCITECO_FULL) -im -- @srcdir@/grosciteco.tes $$@ -endef +# NOTE: grosciteco.tes generates two artifacts, but two targets in one rule would be independent. +# Grouped targets (&:) on the other hand are unreliable/buggy. +%.woman.tec : %.woman; -$(eval $(call woman_man_rule,grosciteco.tes.1)) -$(eval $(call woman_man_rule,tedoc.tes.1)) -$(eval $(call woman_man_rule,sciteco.1)) -$(eval $(call woman_man_rule,sciteco.7)) +%.woman : % sciteco.tmac grosciteco.tes + @GROFF@ @GROFF_FLAGS@ -wall -Z -Tutf8 -t -man -M@srcdir@ -msciteco $< | \ + $(SCITECO_FULL) -im -- grosciteco.tes $@ -tutorial.woman tutorial.woman.tec &: tutorial.ms sciteco.tmac grosciteco.tes +tutorial.woman : tutorial.ms sciteco.tmac grosciteco.tes @GROFF@ @GROFF_FLAGS@ -wall -Z -Tutf8 -t -ms -M@srcdir@ -msciteco $< | \ - $(SCITECO_FULL) -im -- @srcdir@/grosciteco.tes $@ + $(SCITECO_FULL) -im -- grosciteco.tes $@ man_MANS = grosciteco.tes.1 tedoc.tes.1 sciteco.1 sciteco.7 -dist_noinst_SCRIPTS = htbl.tes +dist_noinst_SCRIPTS += htbl.tes if BUILD_HTMLDOCS html_DATA = grosciteco.tes.1.html tedoc.tes.1.html \ diff --git a/doc/cheat-sheet.mm b/doc/cheat-sheet.mm index ba7247c..9a63f4e 100644 --- a/doc/cheat-sheet.mm +++ b/doc/cheat-sheet.mm @@ -825,7 +825,12 @@ Binary negate \fIn\fP \(em negate TECO boolean. . TD . CI "" n = . TD -Show value of \fIn\fP in message line. +Show value of \fIn\fP in message line (decimal). +. TRX +. TD +. CI "" n === +. TD +Show value of \fIn\fP in message line (hexadecimal). . TRX . TD colspan=2 Q-Registers consist of 2 cells: strings and integers. diff --git a/doc/grosciteco.tes b/doc/grosciteco.tes.in index c4f16e1..c4f16e1 100755 --- a/doc/grosciteco.tes +++ b/doc/grosciteco.tes.in diff --git a/doc/sciteco.1.in b/doc/sciteco.1.in index 0ed9f85..e47ca93 100644 --- a/doc/sciteco.1.in +++ b/doc/sciteco.1.in @@ -450,12 +450,22 @@ and opening files specified on the command line. .B $SCITECOPATH/*.tes Standard library macros. .TP -.SCITECO_TOPIC savepoint +.BI # filename # +Recovery file: +After a configurable recovery interval \*(ST dumps up all modified buffers +(unsaved changes), that have not been dumped previously. +These files should be ignored by version control systems and may +be left around after crashes and unexpected restarts. +See \fB6EJ\fP for more details. +.TP +.SCITECO_TOPIC savepoint backup .BI .teco- n - filename ~ Save point files created by \*(ST when saving files during interactive execution have this format. On Windows, these files have the hidden attribute set. -Savepoint files are temporary and should be ignored by version +They are internally used when rubbing out file saves +and are conceptually similar to backup files in other editors. +However they are temporary and should be ignored by version control systems, etc. .TP .SCITECO_TOPIC ".teco_session" session diff --git a/doc/sciteco.7.template b/doc/sciteco.7.template index c097b70..cb718e0 100644 --- a/doc/sciteco.7.template +++ b/doc/sciteco.7.template @@ -874,8 +874,9 @@ areas\fP. .IP \(bu The \fIcommand line area\fP, showing the currently effective and rubbed-out command line as it is edited. -This is currently a single line of text that is scrolled -automatically. +This is a single line by default, but can be configured with \(lq5EJ\(rq. +Since it is also a Scintilla view, it can be further customized by +running \(lq0,2048ED\(rq and invoking Scintilla messages using \fBES\fP. . .SS Colors and Theming .SCITECO_TOPIC colors theming diff --git a/doc/tedoc.tes b/doc/tedoc.tes.in index cc4f726..cc4f726 100755 --- a/doc/tedoc.tes +++ b/doc/tedoc.tes.in |