baum

annotate baum.1 @ 45:0b82169d4129

using fakeroot for creating the tarball; removed executable bit from some files
author meillo@marmaro.de
date Sat, 01 Mar 2008 21:49:41 +0100
parents c7dca4a1dc37
children f9fc4c4f9e3d
rev   line source
meillo@37 1 .TH baum 1 "2008-03-01" "baum 0.3"
meillo@18 2 .SH NAME
meillo@18 3 baum \- an esoteric programming language
meillo@18 4
meillo@18 5
meillo@18 6
meillo@18 7 .SH SYNOPSIS
meillo@18 8 .B baum
meillo@31 9 [\-v]\ <file>
meillo@18 10
meillo@18 11
meillo@18 12
meillo@18 13 .SH DESCRIPTION
meillo@18 14 .B baum
meillo@18 15 is an interpreter for the baum programming language which is an experiment to create an esoteric programming language.
meillo@18 16
meillo@18 17 Source code is a representation of a tree in which every node is a command or data.
meillo@18 18
meillo@18 19 baum is only an experiment and the functionality is (currently) very restricted.
meillo@18 20
meillo@18 21
meillo@18 22
meillo@18 23
meillo@18 24 .SH OPTIONS
meillo@18 25
meillo@18 26 .TP
meillo@18 27 .BI \-v
meillo@42 28 Verbose output (All verbose output goes to stderr)
meillo@18 29
meillo@18 30 .TP
meillo@18 31 .BI \-\-help
meillo@18 32 Print usage information
meillo@18 33
meillo@18 34 .TP
meillo@18 35 .BI \-\-version
meillo@18 36 Print version information
meillo@18 37
meillo@18 38
meillo@18 39
meillo@18 40
meillo@18 41
meillo@18 42
meillo@18 43 .SH SOURCE CODE
meillo@18 44
meillo@18 45 Source code are plain text files with one node per line representing the tree. The indention controls in which level in the tree the node is. Indention can be made with SPACE or with TAB characters. Every character means one level.
meillo@18 46
meillo@18 47 Empty lines and everything vom the hash symbol (`#') to the end of the line is ignored.
meillo@18 48
meillo@37 49 .B An example that echoes (and returns) `42':
meillo@18 50
meillo@18 51 .nf
meillo@18 52 # comment
meillo@18 53 print(0)
meillo@18 54 sum(0) #comment
meillo@18 55 number(40)
meillo@18 56 number(2)
meillo@18 57 .fi
meillo@18 58
meillo@18 59
meillo@18 60
meillo@18 61 .SH CONCEPT
meillo@18 62
meillo@18 63 baum programs are represented as nodes in a tree structure. Nodes are of specific kind and contain a value.
meillo@18 64
meillo@18 65 The tree is processed recursive starting at the root node. Every node controls it's sons and should only know them; while most nodes only use their leftmost son.
meillo@18 66
meillo@37 67 Each node returns a value to it's parent. (The root node returns an exit code to the shell.) The internal value of the node could be used in any useful way, but only inside the node.
meillo@18 68
meillo@18 69 All values in the language (return values, expected return values and in-node values) should be of the same type, so that every combination of nodes is possible.
meillo@18 70
meillo@18 71 Nodes can modify the tree, but should do this only on it's brothers or better only through it's rightmost brother.
meillo@18 72
meillo@18 73
meillo@18 74 .SH ERRORS
meillo@18 75
meillo@43 76 You have to keep in mind, that valid programs that run successful can return exit codes different from zero too! Each program returns the return value of the root node to the shell. If you don't want your program doing this, just set a `number(0)' node as root, and put everything else below.
meillo@43 77
meillo@18 78 .TP
meillo@18 79 .BI 1
meillo@18 80 common error
meillo@18 81
meillo@18 82 .TP
meillo@18 83 .BI 3
meillo@18 84 no or more than one source file given
meillo@18 85
meillo@18 86 .TP
meillo@18 87 .BI 4
meillo@18 88 invalid node
meillo@18 89
meillo@18 90 .TP
meillo@31 91 .BI 5
meillo@31 92 indention over more than one level
meillo@31 93
meillo@31 94 .TP
meillo@33 95 .BI 6
meillo@33 96 node name too long, or no value given
meillo@33 97
meillo@33 98 .TP
meillo@42 99 .BI 126
meillo@18 100 invalid command line options
meillo@18 101
meillo@18 102
meillo@18 103
meillo@18 104 .SH BUGS
meillo@18 105 Please report if you find some.
meillo@18 106
meillo@18 107
meillo@18 108 .SH CREDITS
meillo@18 109 Ju developed the idea of
meillo@18 110 .B baum
meillo@18 111 with me in a conversation. Actually it was his idea to use the tree as basic structure.
meillo@18 112
meillo@18 113
meillo@18 114
meillo@18 115 .SH AUTHOR
meillo@18 116 markus schnalke <meillo@marmaro.de> and julian forster