[hcoop/zz_old/debian/smlnj.git] / debian / nowhere.1

.TH nowhere 1 "July 21, 2004"
.SH NAME
nowhere \- a tree parser generator for Standard ML
.SH SYNOPSIS
.B nowhere
.I file
.br
.SH DESCRIPTION
This manual page documents briefly the
.B nowhere
command.
This manual page was written for the Debian distribution
because the original program does not have a manual page.

The
.B nowhere
program is a simple source to source translation tool that expands out
case expressions with conditional patterns.

Conditional patterns use the "where" keyword.  For example:

 case l of
   [x,y,z] where x=1 => 1
 | _ => 2

means the same as:

 case l of
   [1,y,z] => 1
 | _ => 2

Currently, the input file must be of the following form:

 local
   <definitions>
 in
   <body>
 end
   <definitions>

should include all datatypes definitions that are used inside the
.IR body .
It is only for the tool's benefit and does not appear in the output.
Only
.I body
appears at the output.  You can use the special declaration

     include "filename"

to import extra definitions.

The tool translates all case expressions with guards into the appropriate code.

.SH SEE ALSO
.I /usr/share/doc/nowhere/README
.br
.SH AUTHOR
This manual page was written by Aaron Read <amread@nyx.net>. for the
Debian GNU/Linux system (but may be used by others)
Commit	Line	Data
4dd335d4 JM	1	.TH nowhere 1 "July 21, 2004"
	2	.SH NAME
	3	nowhere \- a tree parser generator for Standard ML
	4	.SH SYNOPSIS
	5	.B nowhere
	6	.I file
	7	.br
	8	.SH DESCRIPTION
	9	This manual page documents briefly the
	10	.B nowhere
	11	command.
	12	This manual page was written for the Debian distribution
	13	because the original program does not have a manual page.
	14
	15	The
	16	.B nowhere
	17	program is a simple source to source translation tool that expands out
	18	case expressions with conditional patterns.
	19
	20	Conditional patterns use the "where" keyword. For example:
	21
	22	case l of
	23	[x,y,z] where x=1 => 1
	24	\| _ => 2
	25
	26	means the same as:
	27
	28	case l of
	29	[1,y,z] => 1
	30	\| _ => 2
	31
	32	Currently, the input file must be of the following form:
	33
	34	local
	35	<definitions>
	36	in
	37	<body>
	38	end
	39	<definitions>
	40
	41	should include all datatypes definitions that are used inside the
	42	.IR body .
	43	It is only for the tool's benefit and does not appear in the output.
	44	Only
	45	.I body
	46	appears at the output. You can use the special declaration
	47
	48	include "filename"
	49
	50	to import extra definitions.
	51
	52	The tool translates all case expressions with guards into the appropriate code.
	53
	54	.SH SEE ALSO
	55	.I /usr/share/doc/nowhere/README
	56	.br
	57	.SH AUTHOR
	58	This manual page was written by Aaron Read <amread@nyx.net>. for the
	59	Debian GNU/Linux system (but may be used by others)