Chapter 6: Index to CML Functions |
[TOP] [PREV] |
This alphabetical index to the complete list of CML functions includes a very brief description of the purpose of each function.
| $ad_author() | set psuedonymn for response | |
| $ad_item() | Add an item (obsolete) | |
| $ad_resp() | Add a response (obsolete) | |
| $add_item() | Add an item | |
| $add_resp() | Add a response | |
| $admin_mail() | Caucus Administrator e-mail | |
| $all_users() | list caucus userids | |
| $and() | logical 'and' | |
| $append() | append text to a file | |
| $arg() | argument to CML page | |
| $asc2dec() | decimal values of characters in string | |
| $asynch() | run shell asynchronously | |
| $between() | a <= x <= b? | |
| $bit_and() | bitwise and | |
| $bit_not() | bitwise negation | |
| $bit_or() | bitwise or | |
| $browser_format() | browser language code | |
| $cache_clear() | Clears (conference) cache | |
| $cache_timeout() | Set maximum age of (conference) cache | |
| $caucus_id() | Caucus userid | |
| $caucus_lib() | caucus library directory | |
| $caucus_path() | caucus home directory | |
| $char() | Convert decimal value to a single character | |
| $charval() | Value of a character in a string | |
| $chg_resp() | Change text of response | |
| $chg_title() | Change title of item | |
| $cl_access() | user's access level to conference | |
| $cl_list() | get list of conference numbers | |
| $cl_name() | get name of a conference | |
| $cl_num() | get number of a conference name | |
| $cl_visible() | conference visible to this user? | |
| $cleanhtml() | clean HTML filter | |
| $clear_conf_var() | Clear conf variable cache | |
| $clear_item_var() | Clear item variable cache | |
| $clear_site_var() | Clear site variable cache | |
| $clear_user_var() | Clear user variable cache | |
| $close() | close open file | |
| $cml_dir() | CML directory in URL | |
| $cml_page() | cml file name | |
| $cml_path() | cml directory path | |
| $co_add() | can users add new items? | |
| $co_change() | can users change their responses? | |
| $co_greet() | conference greeting text | |
| $co_intro() | conference introduction text | |
| $co_makeorg() | add an organizer | |
| $co_name() | name of conference | |
| $co_org() | userid of organizer | |
| $co_remove() | delete conference | |
| $co_rename() | rename conference | |
| $co_userlist() | conference 'userlist' | |
| $co_visible() | conf visible to non-members? | |
| $conf_var() | value of a conference variable | |
| $copy2lib() | copy file to file library | |
| $copyfile() | copy files | |
| $create_conf() | create conference | |
| $dateof() | convert time in seconds to full date form | |
| $debug() | debugging switch | |
| $dec2hex() | decimal to hexadecimal conversion | |
| $delfile() | delete a file | |
| $dirlist() | list directory | |
| $disk_failure() | disk-write error occurred? | |
| $divide() | integer quotient of two numbers | |
| $dosfile() | truncate to 8 char filename | |
| $empty() | is string empty? | |
| $epoch() | convert date to epoch time | |
| $equal() | test equality of two strings | |
| $errors() | display accumulated error messages | |
| $escquote() | escape double-quotes | |
| $file() | include contents of file 'name' | |
| $file_data() | check contents of file against a range of values | |
| $find_filter() | Display results of search | |
| $find_it() | Search items for text | |
| $form() | HTML forms data | |
| $gen_sort() | alphabetic sort | |
| $goodbye() | make server exit in one minute | |
| $greater() | A > B? | |
| $gt_equal() | A >= B? | |
| $hex2dec() | hexadecimal conversion | |
| $host() | host name | |
| $http_lib() | URL of Caucus library | |
| $http_remote_user() | access authorization user id | |
| $http_user_agent() | browser name | |
| $if() | if/else expansion | |
| $ifthen() | if/then expansion | |
| $inc() | argument to include file | |
| $is_passwd() | Is there a password changer? | |
| $it_exists() | does item exist? | |
| $it_frozen() | is item frozen? | |
| $it_howmuch() | how much seen by a user? | |
| $it_icount() | actual number of items | |
| $it_iforgot() | number of forgotten items | |
| $it_inew() | # of new items in conference | |
| $it_iunseen() | number of unseen items | |
| $it_join() | make user member of conf | |
| $it_last() | last item in conference | |
| $it_lastresp() | last undeleted response in item | |
| $it_listinew() | list of new items in conference | |
| $it_listiunseen() | list of unseen items | |
| $it_listrnew() | list of new responses in conf. | |
| $it_member() | user member of conference? | |
| $it_new() | Is item new? | |
| $it_newr() | First new response to item | |
| $it_pack() | inverse of $it_parse | |
| $it_parse() | parse list of items | |
| $it_resign() | remove user from conf. | |
| $it_resps() | Number of responses to item | |
| $it_rnew() | total # of new responses in conf. | |
| $item_sort() | sort by title, author, date | |
| $it_unseen() | Is item unseen? | |
| $it_visib() | Is item visible to current user? | |
| $it_wnew() | # of items with new responses | |
| $item_var() | value of an item variable | |
| $jshell() | japanese shell command | |
| $lice_act_users() | actual # users | |
| $lice_confs() | maximum number of confs | |
| $lice_customer() | license customer number | |
| $lice_expires() | epoch time at which license expires | |
| $lice_max_users() | total # users allowed | |
| $list_conf_var() | list conf variables | |
| $list_item_var() | list item variables | |
| $list_site_var() | list site variables | |
| $list_user_var() | list user variables | |
| $less() | A < B? | |
| $lower() | convert to lower case | |
| $mac_define() | macro definition | |
| $mac_expand() | macro expansion | |
| $max() | maximum of A and B | |
| $mgr_list() | get list of managers | |
| $min() | minimum of A and B | |
| $minus() | subtract two numbers | |
| $mult() | product of two numbers | |
| $my_exist() | does this user exist? | |
| $my_intro() | brief introduction of current user | |
| $my_laston() | date user last on caucus | |
| $my_name() | name of current user | |
| $my_phone() | telephone of current user | |
| $my_text() | when does my text appear new? | |
| $new_win() | set size of windows created by $t2url() | |
| $newline() | produce 'newline' character | |
| $not() | logical 'not' | |
| $not_empty() | is string non-empty? | |
| $not_equal() | test equality of two strings | |
| $numeric() | is a word a number? | |
| $num_sort() | numerical sort | |
| $open() | open a file | |
| $opsys() | host server operating system | |
| $or() | logical 'or' | |
| $output() | redirect HTML output | |
| $pad() | provide blank padding | |
| $page_caller() | get caller of a page | |
| $page_get() | value of saved page reference | |
| $page_return() | return to a saved page | |
| $page_save() | save page reference | |
| $pagetime() | value of PageTime parameter in swebd.conf | |
| $passcheck() | Check id and password | |
| $passwd() | change user's password | |
| $peo_members() | list of members of conference | |
| $peo_names() | find people by name | |
| $per_delete() | delete person | |
| $per_intro() | person's brief introduction | |
| $per_lastin() | time last in a conf | |
| $per_laston() | date/time person last on caucus | |
| $per_name() | person's name | |
| $per_phone() | person's telephone | |
| $per_real() | real name of userid | |
| $pid() | swebs process id | |
| $plus() | add two numbers | |
| $plusmod() | a + b modulo x | |
| $protect() | Allow only safe CML functions | |
| $pw_add() | Add a userid | |
| $pw_change() | Change a password | |
| $pw_delete() | Delete a userid | |
| $pw_verify() | Verify correct password | |
| $pw_can_add() | Can we add a userid? | |
| $pw_can_change() | Can we change a password? | |
| $pw_can_delete() | Can we delete a userid? | |
| $pw_can_verify() | Can we verify correct password? | |
| $quote() | "Quote" words as one word | |
| $random() | random number | |
| $re_author() | Author of response | |
| $re_copied() | Information about copied response | |
| $re_copier() | Userid that copied this response | |
| $re_bits() | response property bits | |
| $re_delete() | delete item or response | |
| $re_epoch() | resp time in seconds | |
| $re_exists() | Does response exist? | |
| $re_owner() | Owner of response | |
| $re_prop() | Property number of response | |
| $re_text() | Text of response | |
| $re_time() | Date/time response written | |
| $re_title() | Title of item | |
| $readfile() | read contents of file | |
| $readln() | read line from file | |
| $readterm() | read a line from user's terminal | |
| $reloaded() | was this page just reloaded? | |
| $rename() | rename file | |
| $replace() | replace all A's with B's | |
| $rest() | remaining words in a string | |
| $reval() | Recursive CML evaluation | |
| $rhtml() | see $safehtml | |
| $safehtml() | Text -> safe HTML (obs) | |
| $search_filter() | Display results of search | |
| $search_it() | Search items for text | |
| $set() | set a string | |
| $set_browser_format() | set browser language code | |
| $set_co_add() | control users adding new items | |
| $set_co_change() | allow changing responses | |
| $set_co_org() | set primary organizer | |
| $set_co_userlist() | set text of conference 'userlist' | |
| $set_co_visible() | control conference name visibility | |
| $set_conf_var() | set value of conference variable | |
| $set_it_frozen() | freeze or thaw item | |
| $set_it_seen() | Mark responses seen | |
| $set_item_var() | set value of an item variable | |
| $set_mgr_list() | set list of managers | |
| $set_my_intro() | set user's brief introduction | |
| $set_my_name() | set current user's name | |
| $set_my_phone() | set current user's telephone | |
| $set_my_text() | set when text appears new | |
| $set_per_intro() | set a person's brief introduction | |
| $set_per_join() | make a person a member of a conference | |
| $set_per_name() | set a person's name | |
| $set_per_phone() | set a person's phone | |
| $set_user_var() | set value of a user variable | |
| $set_wrap() | control paragraph wrapping | |
| $shell() | run shell command | |
| $silent() | run shell command quietly | |
| $sizeof() | number of words in a string | |
| $str_index() | find string in other string | |
| $str_revdex() | reverse find string | |
| $str_sub() | extract a substring | |
| $strlen() | length of string | |
| $t2amp() | escape &'s | |
| $t2esc() | escape & < > | |
| $t2hbr() | Text -> lines with <BR>'s | |
| $t2html() | Text -> formatted HTML | |
| $t2mail() | translate to e-mail URL | |
| $t2url() | Text -> URL's with 'hot' links | |
| $tablefind() | find a word in a string | |
| $time() | current epoch time value | |
| $timezone() | difference between local time and UTC | |
| $triplet_sort() | sort item triplets | |
| $unique() | return a unique number | |
| $unquote() | undoes effect of $quote() | |
| $upper() | convert to upper case | |
| $upper1() | uppercase 1st letter | |
| $user_var() | value of a user variable | |
| $userid() | user's userid | |
| $variables() | display names and values of all variables | |
| $version() | software version number | |
| $weekday() | day # of week | |
| $width() | number of characters | |
| $word() | N'th word of a string | |
| $wordpos() | character position of a word in a string | |
| $words() | subset of words of a string | |
| $wrap2html() | wordwrap text -> HTML | |
| $wraptext() | wordwrap text | |
| $write() | write text to a file | |
| $writeln() | write text to file | |
| $xshell() | comprehensive shell access |