reference.adoc

   1 = RRQFORTH Reference Documentation
   2 :author: Ralph Ronnquist <ralph.ronnquist@gmail.com>
   3 :mult: *
   4 :quote: "
   5
   6 include::wordindex.adoc[]
   7
   8 == Word Descriptions
   9
  10 include::adoc/inline_code.adoc[]
  11 include::separator.adoc[]
  12 include::adoc/p_0branch.adoc[]
  13 include::separator.adoc[]
  14 include::adoc/p_0equal.adoc[]
  15 include::separator.adoc[]
  16 include::adoc/p_0less.adoc[]
  17 include::separator.adoc[]
  18 include::adoc/p_1branch.adoc[]
  19 include::separator.adoc[]
  20 include::adoc/p_2drop.adoc[]
  21 include::separator.adoc[]
  22 include::adoc/p_2dup.adoc[]
  23 include::separator.adoc[]
  24 include::adoc/p_2get.adoc[]
  25 include::separator.adoc[]
  26 include::adoc/p_2over.adoc[]
  27 include::separator.adoc[]
  28 include::adoc/p_2put.adoc[]
  29 include::separator.adoc[]
  30 include::adoc/p_2swap.adoc[]
  31 include::separator.adoc[]
  32 include::adoc/p_Ccomma.adoc[]
  33 include::separator.adoc[]
  34 include::adoc/p_Wcomma.adoc[]
  35 include::separator.adoc[]
  36 include::adoc/p_Dcomma.adoc[]
  37 include::separator.adoc[]
  38 include::adoc/p_dsp.adoc[]
  39 include::separator.adoc[]
  40 include::adoc/p_cfa2tfa.adoc[]
  41 include::separator.adoc[]
  42 include::adoc/p_Cget.adoc[]
  43 include::separator.adoc[]
  44 include::adoc/p_Wget.adoc[]
  45 include::separator.adoc[]
  46 include::adoc/p_Rget.adoc[]
  47 include::separator.adoc[]
  48 include::adoc/p_Cput.adoc[]
  49 include::separator.adoc[]
  50 include::adoc/p_Wput.adoc[]
  51 include::separator.adoc[]
  52 include::adoc/p_Dput.adoc[]
  53 include::separator.adoc[]
  54 include::adoc/p_Rget.adoc[]
  55 include::separator.adoc[]
  56 include::adoc/p_Rgt.adoc[]
  57 include::separator.adoc[]
  58 include::adoc/p_abs.adoc[]
  59 include::separator.adoc[]
  60 include::adoc/p_again.adoc[]
  61 include::separator.adoc[]
  62 include::adoc/p_allot.adoc[]
  63 include::separator.adoc[]
  64 include::adoc/p_and.adoc[]
  65 include::separator.adoc[]
  66 include::adoc/p_args.adoc[]
  67 include::separator.adoc[]
  68 include::adoc/p_base.adoc[]
  69 include::separator.adoc[]
  70 include::adoc/p_begin.adoc[]
  71 include::separator.adoc[]
  72 include::adoc/p_bracketed_quote.adoc[]
  73 include::separator.adoc[]
  74 include::adoc/p_branch.adoc[]
  75 include::separator.adoc[]
  76 include::adoc/p_break.adoc[]
  77 include::separator.adoc[]
  78 include::adoc/p_calltrace.adoc[]
  79 include::separator.adoc[]
  80 include::adoc/p_cfa2flags_get.adoc[]
  81 include::separator.adoc[]
  82 include::adoc/p_clear_stream.adoc[]
  83 include::separator.adoc[]
  84 include::adoc/p_colon.adoc[]
  85 include::separator.adoc[]
  86 include::adoc/p_comma.adoc[]
  87 include::separator.adoc[]
  88 include::adoc/p_create.adoc[]
  89 include::separator.adoc[]
  90 include::adoc/p_current_wordlist.adoc[]
  91 include::separator.adoc[]
  92 include::adoc/data_stack.adoc[]
  93 include::separator.adoc[]
  94 include::adoc/p_decimal.adoc[]
  95 include::separator.adoc[]
  96 include::adoc/p_definitions.adoc[]
  97 include::separator.adoc[]
  98 include::adoc/p_depth.adoc[]
  99 include::separator.adoc[]
 100 include::adoc/p_dfa2tfa.adoc[]
 101 include::separator.adoc[]
 102 include::adoc/p_digits.adoc[]
 103 include::separator.adoc[]
 104 include::adoc/p_div.adoc[]
 105 include::separator.adoc[]
 106 include::adoc/p_divmod.adoc[]
 107 include::separator.adoc[]
 108 include::adoc/p_dodoes.adoc[]
 109 include::separator.adoc[]
 110 include::adoc/p_does.adoc[]
 111 include::separator.adoc[]
 112 include::adoc/p_dofasm.adoc[]
 113 include::separator.adoc[]
 114 include::adoc/p_doforth.adoc[]
 115 include::separator.adoc[]
 116 include::adoc/p_dostring.adoc[]
 117 include::separator.adoc[]
 118 include::adoc/p_dot.adoc[]
 119 include::separator.adoc[]
 120 include::adoc/p_dot_temp.adoc[]
 121 include::separator.adoc[]
 122 include::adoc/p_double_quote.adoc[]
 123 include::separator.adoc[]
 124 include::adoc/p_dovalue.adoc[]
 125 include::separator.adoc[]
 126 include::adoc/p_dovariable.adoc[]
 127 include::separator.adoc[]
 128 include::adoc/p_drop.adoc[]
 129 include::separator.adoc[]
 130 include::adoc/p_dup.adoc[]
 131 include::separator.adoc[]
 132 include::adoc/p_else.adoc[]
 133 include::separator.adoc[]
 134 include::adoc/p_emit.adoc[]
 135 include::separator.adoc[]
 136 include::adoc/p_end.adoc[]
 137 include::separator.adoc[]
 138 include::adoc/p_equal.adoc[]
 139 include::separator.adoc[]
 140 include::adoc/p_erase.adoc[]
 141 include::separator.adoc[]
 142 include::adoc/p_evaluate_stream.adoc[]
 143 include::separator.adoc[]
 144 include::adoc/p_execute.adoc[]
 145 include::separator.adoc[]
 146 include::adoc/p_exit.adoc[]
 147 include::separator.adoc[]
 148 include::adoc/p_false.adoc[]
 149 include::separator.adoc[]
 150 include::adoc/p_fdemit.adoc[]
 151 include::separator.adoc[]
 152 include::adoc/p_fdtell.adoc[]
 153 include::separator.adoc[]
 154 include::adoc/p_find.adoc[]
 155 include::separator.adoc[]
 156 include::adoc/p_forth.adoc[]
 157 include::separator.adoc[]
 158 include::adoc/p_get.adoc[]
 159 include::separator.adoc[]
 160 include::adoc/p_get_n_decrement.adoc[]
 161 include::separator.adoc[]
 162 include::adoc/p_get_n_increment.adoc[]
 163 include::separator.adoc[]
 164 include::adoc/p_greaterequal.adoc[]
 165 include::separator.adoc[]
 166 include::adoc/p_greaterthan.adoc[]
 167 include::separator.adoc[]
 168 include::adoc/p_gtR.adoc[]
 169 include::separator.adoc[]
 170 include::adoc/p_here.adoc[]
 171 include::separator.adoc[]
 172 include::adoc/p_hex.adoc[]
 173 include::separator.adoc[]
 174 include::adoc/p_if.adoc[]
 175 include::separator.adoc[]
 176 include::adoc/p_ifagain.adoc[]
 177 include::separator.adoc[]
 178 include::adoc/p_ifbreak.adoc[]
 179 include::separator.adoc[]
 180 include::adoc/p_immediate.adoc[]
 181 include::separator.adoc[]
 182 include::adoc/p_input.adoc[]
 183 include::separator.adoc[]
 184 include::adoc/p_left_bracket.adoc[]
 185 include::separator.adoc[]
 186 include::adoc/p_lessequal.adoc[]
 187 include::separator.adoc[]
 188 include::adoc/p_lessthan.adoc[]
 189 include::separator.adoc[]
 190 include::adoc/p_literal.adoc[]
 191 include::separator.adoc[]
 192 include::adoc/p_literal_string.adoc[]
 193 include::separator.adoc[]
 194 include::adoc/p_literal_string_compile.adoc[]
 195 include::separator.adoc[]
 196 include::adoc/p_load_buffer_size.adoc[]
 197 include::separator.adoc[]
 198 include::adoc/p_load_file.adoc[]
 199 include::separator.adoc[]
 200 include::adoc/p_lparen.adoc[]
 201 include::separator.adoc[]
 202 include::adoc/p_malloc.adoc[]
 203 include::separator.adoc[]
 204 include::adoc/p_minus.adoc[]
 205 include::separator.adoc[]
 206 include::adoc/p_mult.adoc[]
 207 include::separator.adoc[]
 208 include::adoc/p_negate.adoc[]
 209 include::separator.adoc[]
 210 include::adoc/p_nip.adoc[]
 211 include::separator.adoc[]
 212 include::adoc/p_nl.adoc[]
 213 include::separator.adoc[]
 214 include::adoc/p_not.adoc[]
 215 include::separator.adoc[]
 216 include::adoc/p_number.adoc[]
 217 include::separator.adoc[]
 218 include::adoc/p_open_file.adoc[]
 219 include::separator.adoc[]
 220 include::adoc/p_or.adoc[]
 221 include::separator.adoc[]
 222 include::adoc/p_over.adoc[]
 223 include::separator.adoc[]
 224 include::adoc/p_pad.adoc[]
 225 include::separator.adoc[]
 226 include::adoc/p_pick.adoc[]
 227 include::separator.adoc[]
 228 include::adoc/p_plus.adoc[]
 229 include::separator.adoc[]
 230 include::adoc/p_program_version.adoc[]
 231 include::separator.adoc[]
 232 include::adoc/p_put.adoc[]
 233 include::separator.adoc[]
 234 include::adoc/p_put_plus.adoc[]
 235 include::separator.adoc[]
 236 include::adoc/p_quit.adoc[]
 237 include::separator.adoc[]
 238 include::adoc/p_quote.adoc[]
 239 include::separator.adoc[]
 240 include::adoc/p_rbp.adoc[]
 241 include::separator.adoc[]
 242 include::adoc/p_rbpn.adoc[]
 243 include::separator.adoc[]
 244 include::adoc/p_read_stream_char.adoc[]
 245 include::separator.adoc[]
 246 include::adoc/p_read_stream_line.adoc[]
 247 include::separator.adoc[]
 248 include::adoc/p_read_word.adoc[]
 249 include::separator.adoc[]
 250 include::adoc/p_realloc.adoc[]
 251 include::separator.adoc[]
 252 include::adoc/p_return.adoc[]
 253 include::separator.adoc[]
 254 include::adoc/p_right_bracket.adoc[]
 255 include::separator.adoc[]
 256 include::adoc/p_roll.adoc[]
 257 include::separator.adoc[]
 258 include::adoc/p_rot.adoc[]
 259 include::separator.adoc[]
 260 include::adoc/p_semicolon.adoc[]
 261 include::separator.adoc[]
 262 include::adoc/p_setup_signals.adoc[]
 263 include::separator.adoc[]
 264 include::adoc/p_shift_left.adoc[]
 265 include::separator.adoc[]
 266 include::adoc/p_shift_right.adoc[]
 267 include::separator.adoc[]
 268 include::adoc/p_shift_signed_right.adoc[]
 269 include::separator.adoc[]
 270 include::adoc/p_sp.adoc[]
 271 include::separator.adoc[]
 272 include::adoc/p_state.adoc[]
 273 include::separator.adoc[]
 274 include::adoc/p_stdin.adoc[]
 275 include::separator.adoc[]
 276 include::adoc/p_stream.adoc[]
 277 include::separator.adoc[]
 278 include::adoc/p_stream_nchars.adoc[]
 279 include::separator.adoc[]
 280 include::adoc/p_str2temp.adoc[]
 281 include::separator.adoc[]
 282 include::adoc/p_strlen.adoc[]
 283 include::separator.adoc[]
 284 include::adoc/p_strncmp.adoc[]
 285 include::separator.adoc[]
 286 include::adoc/p_strncpy.adoc[]
 287 include::separator.adoc[]
 288 include::adoc/p_swap.adoc[]
 289 include::separator.adoc[]
 290 include::adoc/p_system.adoc[]
 291 include::separator.adoc[]
 292 include::adoc/p_tell.adoc[]
 293 include::separator.adoc[]
 294 include::adoc/p_temp.adoc[]
 295 include::separator.adoc[]
 296 include::adoc/p_tempheld.adoc[]
 297 include::separator.adoc[]
 298 include::adoc/p_tempspace.adoc[]
 299 include::separator.adoc[]
 300 include::adoc/p_terminate0.adoc[]
 301 include::separator.adoc[]
 302 include::adoc/p_tfa2cfa.adoc[]
 303 include::separator.adoc[]
 304 include::adoc/p_tfa2dfa.adoc[]
 305 include::separator.adoc[]
 306 include::adoc/p_tfa2flags_get.adoc[]
 307 include::separator.adoc[]
 308 include::adoc/p_tfa2namez.adoc[]
 309 include::separator.adoc[]
 310 include::adoc/p_then.adoc[]
 311 include::separator.adoc[]
 312 include::adoc/p_this_word.adoc[]
 313 include::separator.adoc[]
 314 include::adoc/p_true.adoc[]
 315 include::separator.adoc[]
 316 include::adoc/p_tuck.adoc[]
 317 include::separator.adoc[]
 318 include::adoc/p_unequal.adoc[]
 319 include::separator.adoc[]
 320 include::adoc/p_unstream.adoc[]
 321 include::separator.adoc[]
 322 include::adoc/p_use.adoc[]
 323 include::separator.adoc[]
 324 include::adoc/p_verboseQ.adoc[]
 325 include::separator.adoc[]
 326 include::adoc/p_within.adoc[]
 327 include::separator.adoc[]
 328 include::adoc/p_words.adoc[]
 329 include::separator.adoc[]
 330 include::adoc/p_xor.adoc[]
 331 include::separator.adoc[]
 332 include::adoc/return_stack.adoc[]
 333
 334 == System calls
 335 //include::syscalls.adoc[]
 336
 337 RRQFORTH includes function wrapping for all "Linux syscalls", which
 338 generally are described in their "man pages. This wrapping takes the
 339 arguments fro the data stack in reverse order, i.e. the first argument
 340 is deepest.
 341
 342 Use +SYSTEM WORDS+ to get a list of all (321) available syscalls.