Bitbucket is a code hosting site with unlimited public and private repositories. We're also free for small teams!

Close
w_title(Stx document tools distribution)dnl
w_doc_id(stxreadme)dnl
w_author(Panu A. Kalliokoski)dnl

! What is this?

This software distribution is a bunch of tools to deal with structured
text (Stx).  Stx is a kind of plain text format with semantic markup.
Stx is documented in:

 - [Stx-doc.html]
 - [Stx-ref.html]

Of some interest may be also [stxaccred].

There are [a homepage][1] (currently in the author's wiki), and a
distribution page at [2] for this project.  You can contact the author
at [mymail].

[1] http://sange.fi/~atehwa/cgi-bin/piki.cgi/stx2any
[2] http://sange.fi/~atehwa/
[mymail] mailto:atehwa@sange.fi

! Included tools

The following tools are included:

[s2aman]::
	This is the main tool, an utility to convert Stx into other
	formats.
[ssman]::
	A simple literal programming tool for document-programs written
	in Stx.
[gstman]::
	A utility for generating cross references between documents
	written in Stx.
[eufsman]::
	A utility for producing "Usage:" messages and manual pages from
	the same source.
[h2sman]::
	Conversion tool from HTML to Stx.  This makes it easy to import
	documents written in other formats into Stx.  Besides, you can
	tidy an HTML document by converting it first into Stx, then back
	into (X)HTML.
''stx-mode.el''::
	An ''emacs'' mode for writing Stx documents.  Provides syntax
	highlighting, paragraph filling, and simple interfaces to
	''stx2any'' for those who cannot use the command line.
	
! Installation

A traditional ''make && make install'' will do.  You can override the
''make'' variable ''PREFIX'' to install somewhere else than ''/usr''.
Other variables you might want to override include ''EMACSDIR'' and
''MANDIR''.  Take a look at the Makefile[../Makefile].

The installation process of stx2any normally uses ''w3m'' to produce
"usage" messages from Stx.  If you don't want to install ''w3m'', you
can give ''make'' the option ''BUILD_USAGE_WITH=plain'' to avoid using
''w3m''.  The only consequence is that "usage" messages (the output of
''stx2any --help'', for instance) will look cruder.

If you have a debian box, you can build a debian package directly by
saying ''fakeroot debian/rules binary'' and installing the resulting
package with ''dpkg -i''.

Recent activity

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.