diff options
author | dos-reis <gdr@axiomatics.org> | 2009-04-18 06:11:42 +0000 |
---|---|---|
committer | dos-reis <gdr@axiomatics.org> | 2009-04-18 06:11:42 +0000 |
commit | e865a85b43caa6f453304e836dae3b62ca73c635 (patch) | |
tree | c0fc52edfcd7d0e5b4febdc251c24ba8a6b89608 /src/doc/help/what.help | |
parent | 6ad3412bc13d3ae7a5f7f68260a90ae1bd536e03 (diff) | |
download | open-axiom-e865a85b43caa6f453304e836dae3b62ca73c635.tar.gz |
Fix SF/2757715
* Makefile.pamphlet (all-input): Make all-doc a requirement.
(all-doc): Tidy.
* doc/Makefile.in: Likewise. Install help files.
* doc/help: New. Home for help files.
Diffstat (limited to 'src/doc/help/what.help')
-rw-r--r-- | src/doc/help/what.help | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/src/doc/help/what.help b/src/doc/help/what.help new file mode 100644 index 00000000..fb9be977 --- /dev/null +++ b/src/doc/help/what.help @@ -0,0 +1,85 @@ +Copyright The Numerical Algorithms Group Limited 1992-94. All rights reserved. +Copyright (C) 2007-2009, Gabriel Dos Reis. All rights reserved. + +OpenAxiom Help Information. +Section numbers refer to the on-line version of the book +AXIOM: The Scientific Computation System by Richard D. Jenks and Robert S. Sutor + +============================================================================== +A.28. )what +============================================================================== + +User Level Required: interpreter + +Command Syntax: + + - )what categories pattern1 [pattern2 ...] + - )what commands pattern1 [pattern2 ...] + - )what domains pattern1 [pattern2 ...] + - )what operations pattern1 [pattern2 ...] + - )what packages pattern1 [pattern2 ...] + - )what synonym pattern1 [pattern2 ...] + - )what things pattern1 [pattern2 ...] + - )apropos pattern1 [pattern2 ...] + +Command Description: + +This command is used to display lists of things in the system. The patterns +are all strings and, if present, restrict the contents of the lists. Only +those items that contain one or more of the strings as substrings are +displayed. For example, + +)what synonym + +displays all command synonyms, + +)what synonym ver + +displays all command synonyms containing the substring ``ver'', + +)what synonym ver pr + +displays all command synonyms containing the substring ``ver'' or the +substring ``pr''. Output similar to the following will be displayed + +---------------- System Command Synonyms ----------------- + + +user-defined synonyms satisfying patterns: + ver pr + + + )apr ........................... )what things + )apropos ....................... )what things + )prompt ........................ )set message prompt + )version ....................... )lisp *yearweek* + +Several other things can be listed with the )what command: + + categories displays a list of category constructors. + commands displays a list of system commands available at your + user-level. Your user-level is set via the )set userlevel command. To get + a description of a particular command, such as ``)what'', issue )help + what. + domains displays a list of domain constructors. + operations displays a list of operations in the system library. + It is recommended that you qualify this command with one or more + patterns, as there are thousands of operations available. For example, + say you are looking for functions that involve computation of + eigenvalues. To find their names, try )what operations eig. A rather + large list of operations is loaded into the workspace when this command + is first issued. This list will be deleted when you clear the workspace + via )clear all or )clear completely. It will be re-created if it is + needed again. + packages displays a list of package constructors. + synonym lists system command synonyms. + things displays all of the above types for items containing + the pattern strings as substrings. The command synonym )apropos is + equivalent to )what things. + +Also See: +o )display +o )set +o )show + + |