HELP

REBOL Dictionary 2.0


Summary:

Prints information about words and values.

Usage:

help word

Arguments:

word - The word argument. (must be: any-type)

Description:

The HELP function provides a simple way to get information about words and values. To use HELP, supply a word or a value as its argument:


    help quit
    USAGE:
    	QUIT 
    
    DESCRIPTION:
    	 Stops evaluation and exits the interpreter. 
    	 QUIT is a native value.

Other examples:


    help now
    USAGE:
    	NOW /year /month /day /time /zone /date /weekday /precise 
    
    DESCRIPTION:
    	 Returns the current local date and time. 
    	 NOW is a native value.
    
    REFINEMENTS:
    	 /year -- Returns the year only.
    	 /month -- Returns the month only.
    	 /day -- Returns the day of the month only.
    	 /time -- Returns the time only.
    	 /zone -- Returns the time zone offset from GMT only.
    	 /date -- Returns date only.
    	 /weekday -- Returns day of the week as integer (Monday is day 1).
    	 /precise -- Use nanosecond precision


    help insert
    USAGE:
    	INSERT series value /part range /only /dup count 
    
    DESCRIPTION:
    	 Inserts a value into a series and returns the series after the in
sert. 
    	 INSERT is an action value.
    
    ARGUMENTS:
    	 series -- Series at point to insert (Type: series port bitset)
    	 value -- The value to insert (Type: any-type)
    
    REFINEMENTS:
    	 /part -- Limits to a given length or position.
    		 range -- (Type: number series port)
    	 /only -- Inserts a series as a series.
    	 /dup -- Duplicates the insert a specified number of times.
    		 count -- (Type: number)

You can also use HELP to find all the words that match a substring. To do so, provide a string in quotes:


    help "path"
    Found these words: 
       clean-path      function! Cleans-up '.' and '..' in path; return
s the cleane... 
       lit-path!       datatype! lit-path! 
       lit-path?       action!   Returns TRUE for lit-path values. 
       path!           datatype! path! 
       path-thru       function! [url /local purl] 
       path?           action!   Returns TRUE for path values. 
       set-path!       datatype! set-path! 
       set-path?       action!   Returns TRUE for set-path values. 
       split-path      function! Splits a file or URL path. Returns a b
lock contain... 
       to-lit-path     function! Converts to lit-path value. 
       to-path         function! Converts to path value. 
       to-set-path     function! Converts to set-path value.


    help "to-"
    Found these words: 
       caret-to-offset native!   Returns the offset position relative t
o the face o... 
       connect-to-link function! [file args /local data] 
       offset-to-caret native!   Returns the offset in the face's text 
correspondin... 
       to-binary       function! Converts to binary value. 
       to-bitset       function! Converts to bitset value. 
       to-block        function! Converts to block value. 
       to-char         function! Converts to char value. 
       to-date         function! Converts to date value. 
       to-decimal      function! Converts to decimal value. 
       to-email        function! Converts to email value. 
       to-event        function! Converts to event value. 
       to-file         function! Converts to file value. 
       to-get-word     function! Converts to get-word value. 
       to-hash         function! Converts to hash value. 
       to-hex          native!   Converts an integer to a hex issue!. 
       to-idate        function! Returns a standard Internet date strin
g. 
       to-image        function! Converts to image value. 
       to-integer      function! Converts to integer value. 
       to-issue        function! Converts to issue value. 
       to-list         function! Converts to list value. 
       to-lit-path     function! Converts to lit-path value. 
       to-lit-word     function! Converts to lit-word value. 
       to-local-file   native!   Converts a REBOL file path to the loca
l system fil... 
       to-logic        function! Converts to logic value. 
       to-money        function! Converts to money value. 
       to-none         function! Converts to none value. 
       to-pair         function! Converts to pair value. 
       to-paren        function! Converts to paren value. 
       to-path         function! Converts to path value. 
       to-rebol-file   native!   Converts a local system file path to a
 REBOL file ... 
       to-refinement   function! Converts to refinement value. 
       to-set-path     function! Converts to set-path value. 
       to-set-word     function! Converts to set-word value. 
       to-string       function! Converts to string value. 
       to-tag          function! Converts to tag value. 
       to-time         function! Converts to time value. 
       to-tuple        function! Converts to tuple value. 
       to-url          function! Converts to url value. 
       to-word         function! Converts to word value.

You can view all words that are of a specific datatype by specifying the datatype. The example:


    help tuple!
    Found these words: 
       aqua            tuple!    40.100.130 
       bar-color       tuple!    180.180.250 
       base-color      tuple!    200.200.200 
       beige           tuple!    255.228.196 
       black           tuple!    0.0.0 
       blue            tuple!    0.0.255 
       brick           tuple!    178.34.34 
       brown           tuple!    139.69.19 
       button-color    tuple!    44.80.132 
       coal            tuple!    64.64.64 
       coffee          tuple!    76.26.0 
       crimson         tuple!    220.20.60 
       cyan            tuple!    0.255.255 
       forest          tuple!    0.48.0 
       gold            tuple!    255.205.40 
       gray            tuple!    128.128.128 
       green           tuple!    0.255.0 
       ivory           tuple!    255.255.240 
       khaki           tuple!    179.179.126 
       leaf            tuple!    0.128.0 
       linen           tuple!    250.240.230 
       magenta         tuple!    255.0.255 
       main-color      tuple!    200.200.200 
       maroon          tuple!    128.0.0 
       mint            tuple!    100.136.116 
       navy            tuple!    0.0.128 
       oldrab          tuple!    72.72.16 
       olive           tuple!    128.128.0 
       orange          tuple!    255.150.10 
       over-color      tuple!    44.80.132 
       papaya          tuple!    255.80.37 
       pewter          tuple!    170.170.170 
       pink            tuple!    255.164.200 
       purple          tuple!    128.0.128 
       reblue          tuple!    38.58.108 
       rebolor         tuple!    142.128.110 
       red             tuple!    255.0.0 
       sienna          tuple!    160.82.45 
       silver          tuple!    192.192.192 
       sky             tuple!    164.200.255 
       snow            tuple!    240.240.240 
       tan             tuple!    222.184.135 
       teal            tuple!    0.128.128 
       violet          tuple!    72.0.90 
       water           tuple!    80.108.142 
       wheat           tuple!    245.222.129 
       white           tuple!    255.255.255 
       yellow          tuple!    255.255.0

would list all tuple functions. Other examples: type "help function!" to list all REBOL defined functions, or even:


    help datatype!
    Found these words: 
       action!         datatype! action! 
       any-block!      datatype! any-block! 
       any-function!   datatype! any-function! 
       any-string!     datatype! any-string! 
       any-type!       datatype! any-type! 
       any-word!       datatype! any-word! 
       binary!         datatype! binary! 
       bitset!         datatype! bitset! 
       block!          datatype! block! 
       char!           datatype! char! 
       datatype!       datatype! datatype! 
       date!           datatype! date! 
       decimal!        datatype! decimal! 
       email!          datatype! email! 
       error!          datatype! error! 
       event!          datatype! event! 
       file!           datatype! file! 
       function!       datatype! function! 
       get-word!       datatype! get-word! 
       hash!           datatype! hash! 
       image!          datatype! image! 
       integer!        datatype! integer! 
       issue!          datatype! issue! 
       library!        datatype! library! 
       list!           datatype! list! 
       lit-path!       datatype! lit-path! 
       lit-word!       datatype! lit-word! 
       logic!          datatype! logic! 
       money!          datatype! money! 
       native!         datatype! native! 
       none!           datatype! none! 
       number!         datatype! number! 
       object!         datatype! object! 
       op!             datatype! op! 
       pair!           datatype! pair! 
       paren!          datatype! paren! 
       path!           datatype! path! 
       port!           datatype! port! 
       refinement!     datatype! refinement! 
       routine!        datatype! routine! 
       series!         datatype! series! 
       set-path!       datatype! set-path! 
       set-word!       datatype! set-word! 
       string!         datatype! string! 
       struct!         datatype! struct! 
       symbol!         datatype! symbol! 
       tag!            datatype! tag! 
       time!           datatype! time! 
       tuple!          datatype! tuple! 
       unset!          datatype! unset! 
       url!            datatype! url! 
       word!           datatype! word!

Related:

? - Prints information about words and values.
?? - Prints a variable name followed by its molded value. (for debugging)
what - Prints a list of globally-defined functions.


<Back | Index | Next>

Copyright 2003 REBOL Technologies