home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Black Box 4
/
BlackBox.cdr
/
editors
/
hypsh40c.arj
/
HYPDOC.LZH
/
QREF.MAN
< prev
next >
Wrap
Text File
|
1991-04-24
|
52KB
|
1,165 lines
HyperShell Hypertext control system Version 4.0
Quick Reference Guide
Copyright (c) 1989,1990,1991 Text Technology
───────────────────────────────────────────────────────────────────────
CONTENTS Page
1. Hyperfile Structure 2
2. HyperShell Directives 2
3. Print Directives 2
4. Check directives 2
5. References 3
6. Formatting flags 3
7. System variables 4
8. Pseudo variables 4
9. Application variables 4
10. Limits 4
11. Actions 5
12. Extended action codes 6
13. Parameters on actions 6
14. Key specifications 6
15. Action modifiers 7
16. Dynamic menus 7
17. Contents lists 7
18. Iterators 7
19. Function codes 8
20. Expression operators 8
21. Conversion string commands 9
22. Pattern Match operators 9
23. Conditions 9
24. Reserved characters in Actions 10
25. Options 10
26. Extended options 11
27. Colour schemes 11
28. Colour codes 12
29. Configuration strings 12
30. Control menu 12
31. Error codes 13
32. Edit actions 14
33. Extra dynamic menus 15
34. Flags in lists 15
35. Extra Functions 15
36. Environment options 15
37. Edit mode primitive function codes 16
38. Graphics characters for Symbol shift 17
39. Default Key Mappings 18
40. Control Keys 18
41. Function Keys 18
42. hs {options} hyperfile {frame} 19
43. hi {options} hyperfile {frame} 19
44. hc {options} hyperfile 19
45. hp {options} hyperfile {frame name} 20
46. hcx {-c/-r/-s){-x/-p/-o/-n}{-t} file 20
47. tagbload filename.ext {mode} 20
48. HyperShell subset popup 21
49. Floating point extension hrxfp 21
50. HyperShell File Extensions 21
HyperShell Version 4.0 - Quick Reference Guide Page 2
1. Hyperfile Structure
┌───┐ ┌───┐ ┌───────────────┐ ┌─────────────────────────────┐
│ H │ │ G │ │ CONTROL ITEMS │ │ INDEX, HEADER, FOOTER, ETC. │
│ │ │ L │ └───────────────┘ └─────────────────────────────┘
│ Y │ │ O │ ┌───────────────┐ ┌─────────────────────────────┐
│ │ │ B │ │ G E N E R A L │ │ N O T E S │
│ P │ │ A │ │ │ │ M E N U S │
│ │ │ L │ │ I T E M S │ │ S C R I P T S │
│ E │ │ S │ │ │ │ R E M A R K S │
│ │ │ │ │ │ │ PRINT AND CHECK │
│ R │ └───┘ └───────────────┘ └─────────────────────────────┘
│ │ ┌───┐ ┌───────────────┐ ───── ┌──────────────────────┐
│ F │ │ F │ │ F R A M E │ │ FRAME, TITLE, TEXT │
│ │ │ R │ │ S P E C │ └──────────────────────┘
│ I │ │ A │ └───────────────┘ ──┐ ┌──────────────────────┐
│ │ │ M │ ┌───────────────┐ │ │ L O C A L I T E M S │
│ L │ │ E │ │ F R A M E │ │ │ N O T E S │
│ │ │ S │ │ S P E C │ │ │ M E N U S │
│ E │ │ │ └───────────────┘ │ │ S C R I P T S │
└───┘ └───┘ - etc - └── └──────────────────────┘
2. HyperShell Directives
.REMARK Remark section
.PRINT directives HP control
.CHECK settings HC control
.NOTE name Global/Local Note
.MENU name Global/Local Menu
.SCRIPT name Global/Local Script
.HEADER Screen header
.FOOTER Screen footer
.INDEX Create .HIX file
.SHARE Shared globals
.FRAME name Frame name
.TITLE title text Frame title
.END End of frame spec.
3. Print Directives
.PRINT TITLE Next line is title
.PRINT OFF Disable print
.PRINT ON Enable print
.PRINT PAGE Page break
.PRINT THIS Following text is printed
.PRINT SECTION prefix Prefix for numbering
.PRINT MARGIN nn set frame margin (for ~i flag)
.PRINT WPOFF Disable -w flag
.PRINT WPON Enable -w flag
4. Check directives
.CHECK +a - check actions in menus with actions
.CHECK +f - check frame refs for menus without actions
.CHECK +p - suppress frame length check
.CHECK +u - suppress errors for unresolved references
.CHECK +x - suppress menu length check
HyperShell Version 4.0 - Quick Reference Guide Page 3
5. References
~?ref text{~Paction}{~Kk}~E - reference(type(name){,action{,key}})
Where ? is :-
~F Frame reference frameref(name{,action}{,k})
~f Frame step
~N Global note noteref(name{,action}{,k})
~n Local note
~t File note
~M Global menu menuref(name{,action}{,k})
~m Local menu
~S Global script scriptref(name{,action}{,k})
~s Local script
~A Action actionref(ref{,action}{,k})
~I Input field inputfield(field,pattern{,k})
6. Formatting flags
~Lnn Line (1-22) linepos(number)
~Ynn Line (1-22) (forced) ypos(number)
~Cnn Column (1-78) column(number)
~Xnn Column (1-78) (forced) xpos(number)
~Wnn Field width (1-72) width(number)
~in Set indent at 'n' spaces (default 0) indent(by)
~G Screen break
~g Line break
~p Do not PRINT rest of this line
~c Concatenate with next line (stops line break)
~Tc Text colour foreground(colour)
~Bc Background colour background(colour)
~Vi Video intensity
~Ds Colour Scheme (A-Z) scheme(letter)
~wn Wait n seconds before continuing wait(seconds)
~d Toggle slow (teletype) display
~On Option setting (0-9,other chars,#)
~Q Immediate reference (after reference)
~H Hidden line
~hc Line/text shown if condition true showif(c)
~jc Line/text hidden if condition true hideif(c)
~Jn Set local flag setlocal(flag)
~Z End of region
~a Mark top left of area
~bn Set bottom right position, draw area per n box(type)
0 - Just return to position set by ~a _return
1 - Draw box from ~a position _double
2 - Define text window and clear it _window
3 - Draw box with window inside and clear _windowbox
Above values +4 - reset text window to full screen
HyperShell Version 4.0 - Quick Reference Guide Page 4
7. System variables
$0 HyperShell program pathname _progpath
$1 Current frame name _frame
$2 Current frame title _title
$3 Current file name _hyperfile
$4 Current date _date
$5 Current time _time
$6 Backtrack list depth _depth
$7 Current directory _curdir
$8 Original directory _original
$9 HyperShell name and version _hypershell
$? Error number of last error _errnum
$@ Remaining memory _memory
$_ File prompt _fprompt
$^ Program exit code _exitstatus
$: Exclusion list of file extns _exclusions
$< Filename from directory display _filename
$> File extension from directory _filetype
$` Error status change action _erroraction
$\ Parameter to Script or Note _parameter
$~ Pattern match translation string _pattrans
8. Pseudo variables
$, represents ';' character _semi
$! represents '|' character _bar
9. Application variables
$A to $Z application variables
$a to $z application variables
$(xxxxxx) named application variable
10. Limits
Reference text - 40 chars
Reference action - 40 chars
References in frame (+ note) - 100
Note text - 76 chars by 22 lines
Frame text - 80 chars
Menu choices - 20 per page
Script lines - 80 chars by 200
(expanded) action string - 120 chars
multiple action string - 120 chars
HyperShell Version 4.0 - Quick Reference Guide Page 5
11. Actions
Aaction do action 'action' action(action)
acaction do 'action' on condition 'c' ifcond(c,action)
B backtrack one frame backtrack()
bn backtrack to depth n backto(depth)
Cd:d Change drive/directory changeto({d:}dir)
cfile interpret file as script call(scriptfile)
Dcommand Dos shell command dodos(command,wait)
dcommand Dos shell command (no wait) dodos(command{,quiet})
Ecommand Execute command (no return) execute(command,over)
evsabc.. Split v on s to a,b,c etc. expand(v,s,abc...)
Fname Go to frame frame(name)
fname Go to frame (no backtrack) framestep(name)
Gfile Display graphic file graphic(file)
gfile Display graphic and stay in mode graphic(file,hold)
Href Add note to notepad addref(ref)
href Remove note from notepad delref(ref)
I{#} Select next{current} input field nextinput({this})
itext Insert text at text cursor insert(text)
Jlabel Unconditional jump goto(label)
jclabel Conditional jump goto(c,label)
Kkkact Map key kk to action mapkey(key,action)
kkkaction Do action mapped to key dokey(key)
Llabel Label name - in script. label(name)
lvnamed Load named var from var v loadvar(v,name)
Mname Global menu menu(name)
mname local menu localmenu(name)
Nname Global note note(name)
nname local note localnote(name)
Oos Set option / colour setopt(opt,val)
ostring Output to printer etc. output(string)
Pstring Popup message popmessage(string)
pstring Display message on bottom line display(string)
Qss Quit to DOS quit(status)
q Quit script quitscript()
Rsabc.. Read file (formatted) read(s,abc...)
rfilenm Open file for reading (close) openin(file), closein()
Sname Global script script(name)
sname local script localscript(name)
Tfilenm Type file typefile(file{,string})
tfilenm Display file as popup note filenote(filename)
Vxvalue Set variable x to value setvar(v,value)
vxvalue Test variable x testvar(v,value)
Wstring Write string to file write(string)
wfilenm Open file for writing (close) openout(file), closeout()
Xcomm Execute command execute(command,wait)
xcomm Execute command (no wait) execute(command)
Y Reset error status to 0 reseterr(value)
y{+/#/-} Display next,current,prev screen refresh(ind)
Zxa Extended action code (see below)
zcaction Do 'action' if 'c' false ifnot(c,action)
HyperShell Version 4.0 - Quick Reference Guide Page 6
12. Extended action codes
ZAkey:action - Specified autoref autoref(key,action)
ZB - Beep (sound bell) beep(param)
Zbn - 0=Bright,1=Blink Background blinkback(status)
ZE - Exit subroutine return()
ZC - Display control menu control()
ZFn - Reserve footer lines reserve(lines)
ZG - Refresh &X,&Y coords getxy()
Zg - Get graphics mouse selection getseln()
ZH - Hold start position of loop holdline()
ZIexpr - If expr TRUE (+ve), do multiact if(expr)
ZJlabel - Jump to Subroutine gosub(label)
ZLn{s} - Toggle frame local flag toggle(flag,noref)
Zlc{i} - Set local flag for contents ind. localind(flag,ind)
ZMn - Set text mode (n = 3,7 or 64) textmode(mode)
ZPfile - Preload hyperfile preload(hyperfile)
ZR - Recall saved screen recall()
Zr - Reset text window to full screen resetwindow()
ZSev=string - Set environment variable setenv(var,value)
ZT - Take copy of whole screen takecopy()
Zt - Show copied screen showcopy()
ZUc - Load character as input unget(c)
ZVname=value - Assign named variable assign(name,value)
ZXnn - Set mouse cursor column setmousex(xpos)
ZYnn - Set mouse cursor line setmousey(ypos)
13. Parameters on actions
-- on Frame actions F and f --
Fname Named frame (normal frame selection)
F Home frame (first in file)
F+ Next frame (wrap at end)
F+1 Next matching frame
F+2 Next unmatched frame
F+name Next named (duplicates)
F- Previous frame (wrap at start)
-- on M,m,F --
Mmenu name(option number) Specified option
Mmenu name[lookup key / pattern] Lookup value
Mmenu name[@] Graphics selection zone action
-- on N,n,t,S,s,c --
Nnote name(parameters) Set variable $\
Sscript name(parameters) Set variable $\
-- on T --
Tfilename/string Type file, searching for string
If string starts '^' it is a pattern
Tfilename#nn Type file, starting at page nn
Tfilename#nn/string Type file at page nn and highlight string
14. Key specifications
(kk = F1-F0,S1-S0,A1-A0,C1-C0,#x)
HyperShell Version 4.0 - Quick Reference Guide Page 7
15. Action modifiers
?prompt Prompt for value prompt(prompt)
?prompt/deflt Prompt giving value to edit prompt(prompt,default)
%envvar Use value of env. var getenv(variable)
&funcspec Use function return
@menuspec Use menu return from(menuspec)
!readspec Iterators (read file etc)
=expr Integer/boolean expression
16. Dynamic menus
@B Backtrack list for unwind unwind()
@b Backtrack list for revisit revisit()
@C{n}{key} Current contents list contents(n,key)
@Dwildspec Directory list (no extn) popdir(wild,noext)
@dwildspec Directory list (with extn) popdir(wild)
@Ewildspec Directory (directories) popdirs(wild)
@Ffilename Contents of file as menu filemenu(filename)
@Gfilename Formatted file list datalist(filename)
@Lwildspec Extended directory display directory(wildcard)
@lwildspec Extended dir with actions diraction(wildcard)
@M/mname Global/local menu from(menu(name)) etc.
@N/n/tname Global/local/file note from(note(name)) etc.
@R Notepad paged display notepad()
@Sstring Search titles of current file search(title,string)
@sstring Search titles of open files search(alltitle,string)
@Xstring Search titles/texts current search(text,string)
@xstring Search titles/texts open fls search(alltext,string)
17. Contents lists
@C{0}{key} Full list {starting with key} full(key)
@C1{key} Matching frames { " } matched(key)
@C2{key} Unmatched frames { " } unmatched(key)
@C3key Start list at frame " startat(key)
@C4key Titles starting with key titlekey(key)
@C5key Start at title starting key starttitle(key)
18. Iterators
!{key} Read next {matching} record readrec(key)
!F{key} Read next {matching} record readnext(key)
!L{key} Read first {matching} record lookuprec(key)
!Bkey Fast lookup (sorted text files) fastlookup(key)
!R{key} Next {matching} reference nextref(key)
!C Associated comment comment(key)
!Dwildcard First matching filename firstfile(wildcard)
!D Next matching filename nextfile()
HyperShell Version 4.0 - Quick Reference Guide Page 8
19. Function codes
&Ac - ASCII value of 1st char asc(c)
&Bp - Scale value to p decimal places scale(p,value)
&Cn - Character of ASCII value nn chr(nn)
&D - Display (0-CGA,1-MDA,2-EGA,3-VGA) adaptor()
&Ekk - Extended key mapping mapping(kk)
&Fcss - String from character c onwards fromchar(c,ss)
&Gtt - Get key with timeout keytimed(timeout)
&H - Time of day as hundredths timehun()
&Icss - Position of char c in string ss instr(c,ss)
&J - Time difference (hundredths) timediff()
&Kss - Key pressed from popup prompt getkey(message)
&Lss - Length of string ss length(ss)
&Mk - String mapped to key k mapone(k)
&Nnss - nth character in string ss nthchar(n,ss)
&OX - Application flag value (X=A-Z) flagval(flag)
&P - Pick word at mouse cursor pickword()
&Q - Pick reference action at mouse pickref()
&Rnn - Run option value (nn = 0 to 21) optval(nn)
&Snss - Substring of ss starting nth frompos(n,ss)
&Tss - Title of frame with name ss title(frame)
&Ucss - String up to character c upto(c,ss)
&Vnn - Configuration string nn configval(nn)
&Wss - Whole string (guard) whole(ss)
&X - X (column) from graphic seln selcol()
&Y - Y (line) from graphic seln selline()
&Z - Key pressed from graphic seln selkey()
&i{def} - input string at text cursor position textin(default)
&vv - Variable address as far pointer varptr(v)
&cparam - HyperShell Resident Extension hrx(param)
&t - Name of last(current) typed file typedfile()
&pn - Last typed file parameters typedparam(n)
vstr - Convert variable 'v' using string convert(v,string)
&l - [IDE] Size of current hyperfile filesize()
&f{d} - [IDE] Free space on cur{named} drive diskfree(d)
20. Expression operators
+,-,*,/,% - arithmetic operators
expr?true exp:false exp - triadic operation
expr!expr - arithmetic or
expr&expr - arithmetic and
expr^expr - exclusive or
@expr - 1's complement
-- Boolean expression operators - 1 if TRUE, 0 if FALSE ---
expra>exprb - a greater than b
expra<exprb - a less than b
expra=exprb - a equal to b
~expr - not expr (0->1,1->0)
#c - Truth of condition code 'c'
"vxxxx"c - combined variable comparison and test
HyperShell Version 4.0 - Quick Reference Guide Page 9
21. Conversion string commands
l - convert to lowercase
u - convert to uppercase
s - strip superfluous spaces
tv - translate according to variable v
rv - remove characters in variable v
ic - (before command) conditional on 'c'
22. Pattern Match operators
< at start - match start of string
> at end - match end of string
? match any character
_ match one or more space or TAB characters
(alt1/alt2) match alt1 or alt2 (if only one, it is optional)
[abc] match 'a', 'b' or 'c'
[^abc] match any character but 'a','b' or 'c'
[x-y] match any char in range x to y (eg. [a-zA-Z] match letter)
{ start of word
} end of word
x# zero or more of the character or subexpression x
x+ one or more of the character or subexpression x
* any string (equivalent to ?#)
\x character 'x' (allows metachars to be used literally)
23. Conditions
e equal _equal
n not equal _notequal
g greater than _greater
l less than _less
d defined _defined
u undefined _undefined
c contains _contains
w contained within _within
m pattern match _match
f pattern fail match _fail
s errorcode set _error
o error code O.K. _ok
r actn mod. returned string _result
b actn mod. returned nothing _noresult
z file operation failure _filerror
A-Z Application flags
v [IDE] set during view mode _viewmode
i [IDE] set for IDE only _IDE
--- Local to frame ---
0-9 local flags
/ matching frame flag _matching
: frame has been visited _visited
< frame over one screen _overscreen
HyperShell Version 4.0 - Quick Reference Guide Page 10
24. Reserved characters in Actions
----- (character 2,3) ------
@ Dynamic menu
& String function
! Read record
= Expression evaluation
% Environment variable
? Prompted input
----- (any character) -----------
$ Variable expansion token
| Action modifier pattern spec
^ (Within frame names) Hyperfile sep
; Multiple action separator
----- (In frame / note text) --------
~ Reference and formatting flag
$ Variable expansion token
. (At beginning of line) Keyword
25. Options
O0 - 0 = Do not produce restart file
1 = Use restart file for notes
2 = Use for notepad, vars and frame
O1 - 0 = Show funct keys, but not symbols
1 = Show symbols
2 = Use 1st letter, no Func keys
4 = Immediate menus on top line
O2 - 0 = No backtrack recording
1 = Record backtrack
O3 - 0 = No frame extns in notepad
1 = Add file name as ref extension
2 = Suppress INS/DEL notepad actions
O4 - 0 = No autoreference
1 = Autoreference frame names
2 = Application specified autoref
4 = Autoreference global notes
O5 - 0 = 'o' output to bottom line
1 = output to printer ( -p flag)
2 = to standard text output
3 = to AUX device
4 = to output file (opened by 'w')
O6 - 0 = exit without displaying memory
1 = Display remaining space on exit
2 = Swap HS.EXE to disk on DOS command
O7 - 0 = No tracing
1 = Trace script labels
O8 - 0 = Don't warn if item not found
1 = Give warnings for item not found
O9 - 0 = 'T' listing interpret ref flags
1 = 'T' listing give verbatim list
2 = As 1, also strips 8th bit
HyperShell Version 4.0 - Quick Reference Guide Page 11
26. Extended options
O*0 - 0 = ESC key does not cancel
1 = ESC key cancels script
O*1 - 0 = No shadows on popups
1 = Shadow edges on popups
O*2 - 0 = No blinking
1 = Blink mouse cursor
2 = Blink cursor and refs
O*3 - 0 = Mouse cursor, keys step 1
1 = Suppress mouse cursor
2 = Cursor keys step as TAB
O*4 - 0 = Autoref typed files
1 = Autoref files & frames
O*5 - 0 = Accept characters < 128
1 = less than 176
2 = less than 255
O*6 - 0 = Search all frames
1 = Search matching only
2 = Search frames not matched
3 = as for 1 and 2, but reset
4 = to 0 after next search
5 to 9 - as 0 to 4 with non-stop
O*7 - n = Tab width (1 to 9)
O*8 - 0 = No comments on noted refs
1 = Request comment on notes
O*9 - 0 = Key mapping case sensitive
1 = Key mapping case insensitive
27. Colour schemes
A wB Action reference
B Wk(bl) Blink
C KC Menu choice
D KW Default title
E yK Frame reference (replace)
F wK Frame reference (stack)
G KK Popup shadow edge
H KY Menu heading
I yY Input field
J KG Note heading and border
K yG Note
L RK Low intensity
M KW Menu reference
N gK Note reference
O yB Menu selection
P yr(bl) Popup message
Q Kk(bl) XOR mask for ref blink (O*22)
R KW Request / message
S yG Script reference
T WK Frame text
U YK (User 1)
V MK (User 2)
W GK (User 3)
X RK (User 4)
Y BK (User 5)
Z rK (User 6)
HyperShell Version 4.0 - Quick Reference Guide Page 12
28. Colour codes
K Black _black
B Blue _blue
G Green _green
C Cyan _cyan
R Red _red
M Magenta _magenta
Y Yellow (Brown) _yellow
W White (light grey) _white
k Dark grey _grey
b Light blue _lightblue
g Light green _lightgreen
c Light cyan _lightcyan
r Light red _lightred
m Light magenta _lightmagenta
y Light yellow _lightyellow
w Bright white _lightwhite
29. Configuration strings
KH1 - Popup directory heading
KH2 - '?' key mapping for frame display
KH3 - '?' key for paged display (menuname)
KH4 - ESCAPE mapping [ZC]
KH5 - HOME mapping [y]
KH6 - END mapping [ZR]
KH7 - PgUp mapping [y-]
KH8 - PgDn mapping [y+]
KH9 - Backspace mapping [B]
KH0 - Control menu heading
KG1 - Default action for RETURN / LEFT Mouse button
KG2 - Default for RETURN / LEFT Mouse button in typed file
KG3 - Default for ESCAPE / RIGHT button in typed file
KG4 - End of title line for Type file and @G list
KG5 - Variable expansion spec for @G formatted list
KG6 - Selection expression for @G list
KG7 - Format line for @G list
KG8 - Character translation - from string
KG9 - Character translation - to string
KG0 - - Reserved -
30. Control menu
KM1 - HOME
KM2 - CONTENTS
KM3 - BACKTRACK
KM4 - SELECT BACK
KM5 - NOTEPAD
KM6 - SEARCH TEXT
KM7 - TYPE FILE
KM8 - DO ACTION
KM9 - DOS SHELL
KM0 - EXIT
HyperShell Version 4.0 - Quick Reference Guide Page 13
31. Error codes
1 - Operation cancelled
2 - No selection from menu
3 - End of file
4 - Cant open file
5 - File not open
6 - File open
7 - File changed
8 - At start of backtrack
9 - Divide by zero
10 - Value not expected
11 - Value expected
12 - Undefined opcode
13 - Unmatched parenthesis
14 - Syntax error
15 - Script not available
16 - Menu not available
17 - Note not available
18 - Frame not available
19 - Key not defined
20 - Invalid key code
21 - Local ref can't be noted
22 - Not at reference
23 - Key not mapped
24 - No action or disabled
25 - Invalid action code
26 - No command
27 - Env var not present
28 - Invalid dynamic menu
29 - Line too wide for screen
30 - String too long
31 - Too many lines in frame
32 - Max script reached
33 - Maximum menu size reached
HyperShell Version 4.0 - Quick Reference Guide Page 14
================ INTEGRATED ENVIRONMENT REFERENCE =================
32. Edit actions
#Atname~tafter Add item and enter edit mode. add(item,after)
#atname~tfrom Add item, copied from other copy(item,from)
#Bmessage Load paged list message/edit string before(string)
#Ctname Check item. check(item)
#Ftname Find item, set 'd' or 'u' lookfor(item)
#Mtname~tafter Move item. move(item,toafter)
#Dtname Delete item. delete(item)
#Utname~tafter Undelete item. undelete(item)
#Vtname view item. view(item)
#Etname edit item. edit(item)
#Onvalue Edit option setting editopt(opt,value)
#Lmmmmm; Left margin default string for frame lmargin(mmmmmm)
#Wnn Right margin default for frame rmargin(nn)
#Ptname Print item, interpreting flags. print(item)
#ptname Print item verbatim (no interp). printv(item)
#Rtname~tnewnm Rename or change details. rename(item,to)
#TFframe~newtit Change title string for frame. rentitle(item,to)
#Ztname zap deleted item. zapdel(item)
#X save and exit. savexit()
#Yfilename save as 'filename' and exit saveas(filename)
#Q quit with no saves. quitedit()
#QQ delete change file, and quit no save quitedit(Q)
#S save file and continue. save()
#I Incremental save. saveinc()
- save changes and index
- can Q after this and index and changes
will be read on next run of HI
#Knnn string Set config string (edit key mapping) setconfig(nn,strg)
Parameters
'tname' (and tafter etc) is made up of 't' and 'name'
't' is the item type specifier
N,n,M,m,S,s - as expected
F - FRAME
R - REMARK t_remark()
E - END t_end()
P - PRINT directive t_print(directive)
C - CHECK directive t_check(settings)
T - Text file t_file(filename)
Extra types
These types may be specified for certain operations
U - HEADER t_header()
V - FOOTER t_footer()
I - INDEX t_index()
Z - SHARE t_share()
HyperShell Version 4.0 - Quick Reference Guide Page 15
33. Extra dynamic menus
@I Global item list globals()
@i Local item list locals()
@Z Deleted item list deleted()
@P{n}{title} Global item popup menu globalpop(n,title)
@p{n}{title} Local item popup menu localpop(n,title)
Values for 'n' are
0 MENU
1 NOTE
2 SCRIPT
3 PRINT
4 CHECK
5 REMARK
6 END
@Ystring Global item search searchglob(string)
@ystring Local item search searchloc(string)
@U Check frame texts checkframes()
@V Check global items checkglobal()
@v Check local items checklocal()
34. Flags in lists
blank Item is in original file
M Item is in memory
C Item is in the change file
R Item is readonly control item (not displayed)
? Item failed last scan check
35. Extra Functions
&f{d} Free space on default (specified) drive
&l Length of current hyperfile
&idefault Input text from current screen position
&0 to &9 Edit mode variables
0 is macro
1 is search string
2 is replace string
3,4 are user definable
5 is edited item name
6 is edited item type name
7 is last deleted (part) line
8 is kill buffer
9 is left margin
36. Environment options
Set via #Onvalue, where n is one of
0 1 Create backup on save (set by -eb)
1 0 (Create file -ec)
2 1 scrollbar (0 = none, 1 = scrollbar)
3 0 assumed indent (for edit mode/checks)
Run option values for &R
28 Edit location (0 = in memory, 1 = from file '-ef')
29 Number of edits so far
HyperShell Version 4.0 - Quick Reference Guide Page 16
37. Edit mode primitive function codes
A Autoref global
a Autoref local
B Beginning of line
b Beginning of word
C Toggle cursor tracking (actual / displayed)
cspec Convert according to 'spec' (see CALL extns)
D Delete current char
d Delete previous char
E End of line
e End of word
F Autoref from frame list
ffspec Append file
Gnn Goto line number nn
gnn Goto column nn
H Toggle flag interpretation
hnspec Popup note
I Toggle Insert/Overwrite
iispec Append item
J Join lines
j Fill / justify / centre paste buffer
K Kill (delete) current line
kstring Load kill buffer
L Insert newline character
l Set temp left margin
M Toggle margins
m Set position at mouse (or scrollbar)
N Next page
n Next line
O open line before
o open line after
P Prev page
p Prev line
Q Quit edit
q Save edit buffer to EDITBUFF.SAV
R Refresh screen
r Set temp right margin
S Toggle symbol shift
ssspec Insert string
T Insert TAB character
tfspec Append text screen
U Undelete line as separate line
u Undelete line inline
V Verbatim character (from keyboard)
v Verify (Check) edit buffer
W wipe reference flags from word
wfspec Append screen with attributes
X Exit edit with save
xsspec Execute function string
Ymessage Ask for confirmation (multiple action line)
ystring Search for string and position cursor
Z Delete to start of line
z Delete to end of line
HyperShell Version 4.0 - Quick Reference Guide Page 17
0 User settable
1 edit mode
2 variables for
3 use with &0 to &4
4 functions
# Store current column,line in &3,&4
. Mark start line
- Cut from start line
+ Paste cut lines
^ Paste first line 'in line'
/filename Save paste buffer to named file
=c actual character 'c'
* copy character from mouse position
< Previous char
> Next char
{ Beginning of paragraph (first line)
} End of paragraph (last line)
( Start of repeat range (must have ; after)
) End of repeat range (end of multi-string)
!action Do action (limited actions only !!!)
Parameters - nspec,fspec,sspec,ispec
Can be a literal string or from action modifier
nspec Note spec = tname,Nname,nname
ispec Item spec = nname,Nname,mname,Mname,sname,Sname,Fname
fspec File spec = filename.ext
sspec String = any string
38. Graphics characters showing mappings in Symbol shift
`abcdefghijklmnopqrstuvwxyz+,./{}| 3 4 5 6 7 8 9 = ; : @ < >
αßΓπΣσµτΦΘΩδ∞φε∩≡±≥≤⌠⌡÷≈°∙·½¼«»√²ⁿ │ ┤ ╡ ╢ ╖ ╕ ╣ ╜ ╗ ║ └ ╝ ╛
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
┴ ┬ ├ - ┼ ╞ ╟ ╚ ╔ ╩ ╦ ╠ ═ ╬ ╧ ╨ ╤ ╥ ╙ ╘ ╒ ╓ ╫ ╪ ┘ ┌
┌─┬─┐ ZDBD? ╔═╦═╗ IMKM; ░ 0 â ä à å Ä Å á
├─┼─┤ CDED4 ╠═╬═╣ LMNM9 ▒ 1 Ç ç
│ │ │ 3 3 3 ║ ║ ║ : : : ▓ 2 é ê ë è É
└─┴─┘ @DADY ╚═╩═╝ HMJM< █ [ ï î ì í
¢ £ ¥ ₧ ƒ ⌐ ¬ ¡
╒═╤═╕ UMQM8 ╓─╥─╖ VDRD7 ▌ ] ô ö ò Ö ó
│ │ │ 3 3 3 ║ ║ ║ : : : ▐ ^ ü û ù Ü ú
╞═╪═╡ FMXM5 ╟─╫─╢ GDWD6 ▀ _ æ Æ
╘═╧═╛ TMOM> ╙─╨─╜ SDPD= ▄ \ ÿ ñ Ñ ª º ¿
HyperShell Version 4.0 - Quick Reference Guide Page 18
39. Default Key Mappings
Enter - Insert new line / break current line
Backspace - Delete previous character
Escape or Right Mouse - Edit menu
LEFT Mouse - Position cursor / use scrollbar
Cursor Up,Down,Left,Right - Prev line, Next line, Prev char, Next char
Home, End - Beginning of line, End of line
Ctrl Home, Ctrl End - Go to start of word, end of word
Page Up, Page Down - Previous page, Next page
Ctrl PgUp, Ctrl PgDn - Go to start, end of buffer
Insert - Toggle Insert mode
Delete - Delete next character
Ctrl Left, Ctrl Right - Delete to start, end of line
40. Control Keys
^A - open new line After current
^B - open new line Before current
^D - Delete inline (from ^X position)
^E - Enter EDIT command
^F - reformat paragraph
^G - Toggle flag interpretation
^J - Join current line to next line
^K - Kill (delete) current line
^L - Set temporary Left margin
^N - Save edit buffer to file EDITBUFF.SAV
^O - Toggle margins (clear temporary margins)
^Q - Quote verbatim character (next char typed)
^R - Set temporary Right margin
^T - Toggle cursor Tracking (actual / visible char)
^U - Undelete line
^V - Verify (check) buffer
^W - Wipe reference flags
^X - Mark start for inline cut (^D to cut)
^Y - paste in line
^Z - duplicate character from mouse position
41. Function Keys
UNSHIFTED SHIFT(flag as) CONTROL (insert) ALTERNATE
F1 - Help menu Frame step Frame reference Frame autoref
F2 - Refresh Frame ref Global item ref Global note autoref
F3 - Macro (check) Global note Local item ref Local note autoref
F4 - Swap with mark Local note Append Frame Search/replace
F5 - Mark for cut Global menu App Global item Search again
F6 - Cut from mark Local menu App Local item Search for string
F7 - Paste lines Global Script App File text Copy to kill buffer
F8 - Symbol shift Local Script App Screen file Paste kill buffer
F9 - QUIT edit Action App Screen (att) DOS exit
F10 - Save & exit Input field App saved buffer Save PASTE buffer
HyperShell Version 4.0 - Quick Reference Guide Page 19
42. HyperShell Reader
hs {options} hyperfile {frame}
-n Restart file for notes
-r Restart for notes,variables,frame
-s Save screen for redisplay on exit
-m Force use of mouse emulator
-f Suppress symbols on menus
-b Suppress backtrack recording
-a Switch on autoreferencing
-u Display available memory on exit
-x Suppress file suffix on notepad
-t Trace labels in scripts
-h MDA/Hercules highlighting scheme
-g CGA/EGA highlighting scheme
-z Flash mouse cursor
-l Verbatim Type file listing
-k Verbatim and strip 8th bit
-d Use BIOS for display
-q Stop Crl-C/Ctrl-Break
-vVstring Set variable V to string
43. HyperShell Integrated Environment
hi {options} hyperfile {frame}
OPTIONS AS FOR HS - PLUS
-ef Work against file, rather than in memory
-eb Delete original, rather than saving as .BAK
44. HyperShell Checker
hc {options} hyperfile
-t suppress audit trail
-h translate .HSL source to .HYP first
-j just translate .HSL file
-dname=defn define source variable (name=val)
-ifile include file
-l list complete hyperfile
-n suppress line numbers in listing
-e list with embedded errors, (sets -l, -n and -o)
-c create unrefd frames etc
-u suppress error messages for unrefd items
-g extended autogeneration (sets -e -c -u -o_
-b autoreference
-k extended autoreference (sets -l -n -u -b -o)
-o produce file filename.CHK
-a do action checks for menus with actions
-x suppress menu length check
-f do frame reference checks for menus without actions
-p suppress frame length check (paged frames)
-r produce reference counts
-s suppress summary totals
-z produce cross reference file
HyperShell Version 4.0 - Quick Reference Guide Page 20
45. HyperShell Print program
hp {options} hyperfile {frame name}
-p output straight to printer
-e output to printer using print effects
-l with -p or -e, set letter quality
-tn assume tab size of 'n'
-mn assume left margin on frames of n
-hnn page height nn rather than 66
-s soft formfeeds
-n Do not do page breaks, or index
-w Format for word processor (sets -n)
-d use default heading, rather than first title
-r list reference details after frame
-g include notes (glossary)
-f full list including items
-o print one frame (with notes if -f)
-i ignore print directives
-a stop and ask before each new page
-v configuration file diagnostic display
46. HyperShell Compress program
hcx {-c/-r/-s){-x/-p/-o/-n}{-t} file
COMPRESSION
-c compress
-r rename
-s secret (one way compression for primary hyperfile only)
EXPANSION
-x expand to file
-p paged display
-o expand to output
-n just show filename
BOTH
-t remove/add <CR> chars
47. BLOAD image tagger
tagbload filename.ext {mode}
Mode Resolution Colours
0 or 1 40x25 text - 16
2 or 3 80x25 text - 16
4 or 5 320x200 graphics - 4
6 640x200 graphics - 2
7 80x25 text - Monochrome with attributes
7 720x350 graphics - Hercules monochrome
13 320x200 graphics - 16
14 640x200 graphics - 16 (1 showing)
15 640x350 graphics - 4
16 640x350 graphics - 16 (1 showing)
17 640x480 graphics - 2
18 640x480 graphics - 16 (1 showing)
54 to 59 and other special modes may also work, depending on adaptor
HyperShell Version 4.0 - Quick Reference Guide Page 21
48. HyperShell subset popup program
hypop filename.ext install
hypop -u uninstall
---- Subset capabilities
.FRAME name (up to 35)
.TITLE title string (up to 35)
text up to 22 lines of 79 columns MAXIMUM.
Default mode referencing uses reference flags ~F and ~E
Automatic mode referencing (.REMARK AUTO) uses autoreference
---- Invocation
Hotkey Alt-/
---- Operation
Keys TAB, BackTAB, cursors, alphabetic keys, to move.
RETURN to select.
Home, PgUp and PgDn move to first, previous and next frames.
F3 is backtrack
F10 key or the ESCAPE key exits
49. HyperShell Floating Point
hrxfp -i install
hrxfp -u uninstall
---- Functions
sin, cos, tan, atan, asin, acos, log, ln, sqrt, exp
c_i, i_c, m_f, f_m, k_m, m_k, k_p, p_k, g_o, o_g, l_g, g_l
d_r, r_d, c_f, f_c
---- Options
#d - decimal
#o - octal
#x - hexadecimal
#b - binary
#c - character
#pn - decimal places
50. HyperShell File Extensions
.HYP Hyperfile
.HIX Hyperfile index
.MNU Menu file
.HSF Script file
.NTE Note file
.CFG Configuration file
.HXC Integrated environment index file
.TMP IDE temporary file
.BAK IDE Backup file
.HCM Compressed file default extn
.HXP Expanded file default extn
.PIC BLOAD image
.PCX Microsoft Paintbrush image
.DAT Database or data file
.TXT Raw text file
.HSL HSL source file
.HSI HSL include file
.CHK HC check output file
.XRF Cross reference