major touch-up into presentable form

[rrq/rrqforth.git] / reference.adoc

diff --git a/reference.adoc b/reference.adoc
index 0d71f8fd0194146821ceec8aeff4bddb06ea33b6..d44db8850766be690d664f62f7f0c800c4abc255 100644 (file)
--- a/reference.adoc
+++ b/reference.adoc
@@ -1,7 +1,9 @@
-RRQFORTH Reference Documentation
-================================
-// :toc:
+= RRQFORTH Reference Documentation
+:author: Ralph Ronnquist <ralph.ronnquist@gmail.com>
+:plus: +
 
+
+== Compilation words
 // include::compile.adoc[]
 include::adoc/p_allot.adoc[]
 include::adoc/p_base.adoc[]
@@ -14,6 +16,7 @@ include::adoc/p_does.adoc[]
 include::adoc/p_evaluate_stream.adoc[]
 include::adoc/p_here.adoc[]
 include::adoc/p_hex.adoc[]
+include::adoc/p_immediate.adoc[]
 include::adoc/p_left_bracket.adoc[]
 include::adoc/p_literal.adoc[]
 include::adoc/p_literal_string.adoc[]
@@ -22,6 +25,7 @@ include::adoc/p_right_bracket.adoc[]
 include::adoc/p_state.adoc[]
 include::adoc/p_this_word.adoc[]
 
+== Logic operation words
 //include::logic.adoc[]
 include::adoc/p_0equal.adoc[]
 include::adoc/p_0less.adoc[]
@@ -39,6 +43,7 @@ include::adoc/p_unequal.adoc[]
 include::adoc/p_within.adoc[]
 include::adoc/p_xor.adoc[]
 
+== Math operation words
 // include::math.adoc[]
 include::adoc/p_abs.adoc[]
 include::adoc/p_divmod.adoc[]
@@ -47,6 +52,7 @@ include::adoc/p_mult.adoc[]
 include::adoc/p_negate.adoc[]
 include::adoc/p_plus.adoc[]
 
+== RRQFORTH main words
 //include::rrqforth.adoc[]
 include::adoc/data_stack.adoc[]
 include::adoc/inline_code.adoc[]
@@ -61,6 +67,7 @@ include::adoc/p_dovalue.adoc[]
 include::adoc/p_dovariable.adoc[]
 include::adoc/p_execute.adoc[]
 include::adoc/p_exit.adoc[]
+include::adoc/p_lparen.adoc[]
 include::adoc/p_program_version.adoc[]
 include::adoc/p_quit.adoc[]
 include::adoc/p_stdin.adoc[]
@@ -68,6 +75,7 @@ include::adoc/p_system.adoc[]
 include::adoc/p_terminate0.adoc[]
 include::adoc/return_stack.adoc[]
 
+== Stack operation words
 //include::stack.adoc[]
 include::adoc/p_2drop.adoc[]
 include::adoc/p_2dup.adoc[]
@@ -76,7 +84,7 @@ include::adoc/p_2swap.adoc[]
 include::adoc/p_depth.adoc[]
 include::adoc/p_drop.adoc[]
 include::adoc/p_dup.adoc[]
-include::adoc/p_ltR.adoc[]
+include::adoc/p_gtR.adoc[]
 include::adoc/p_nip.adoc[]
 include::adoc/p_over.adoc[]
 include::adoc/p_pick.adoc[]
@@ -87,6 +95,7 @@ include::adoc/p_rot.adoc[]
 include::adoc/p_swap.adoc[]
 include::adoc/p_tuck.adoc[]
 
+== Input/output words
 //include::stdio.adoc[]
 include::adoc/p_clear_stream.adoc[]
 include::adoc/p_digits.adoc[]
@@ -103,6 +112,7 @@ include::adoc/p_stream.adoc[]
 include::adoc/p_stream_nchars.adoc[]
 include::adoc/p_tell.adoc[]
 
+== Wordlist words
 //include::wordlists.adoc[]
 include::adoc/p_current_wordlist.adoc[]
 include::adoc/p_find.adoc[]
@@ -110,4 +120,15 @@ include::adoc/p_forth.adoc[]
 include::adoc/p_strncmp.adoc[]
 include::adoc/p_words.adoc[]
 
+== System calls
 //include::syscalls.adoc[]
+
+RRQFORTH includes function wrapping for all "Linux syscalls", which
+generally are described in their "man pages. This wrapping takes the
+arguments fro the data stack in reverse order, i.e. the first argument
+is deepest.
+
+Use +SYSTEM WORDS+ to get a list of all (321) available syscalls.
+
+
+include::wordindex.adoc[]