summaryrefslogtreecommitdiff
path: root/miralib/manual/1
blob: d3eff94e3aae0f8f27534176dcecef63c6be9c12 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
_H_o_w_ _t_o_ _u_s_e_ _t_h_e_ _M_i_r_a_n_d_a_ _o_n_-_l_i_n_e_ _r_e_f_e_r_e_n_c_e_ _m_a_n_u_a_l:

The manual is menu driven, and is  a  separate  subsystem  that  can  be
invoked from the Miranda command interpreter.  To access the manual from
Miranda, type
        /man
followed by return.  To access the  manual  directly  from  the  command
line, without entering Miranda first, type the line
	mira -man
as a shell command.

On entering the manual system  a  contents  page  is  displayed  listing
numbered  sections.   In  response  to the question at the bottom of the
page you should enter the number of the section  you  wish  to  see  and
press  return  (i.e.   ENTER).   The  contents  of that section are then
displayed to you.  When you are ready to leave the manual, press return,
without  giving  ay  section  number, in response to the question at the
foot of the contents page - typing q (for "quit") has the same effect.

If the section is more than one page long, you should  press  the  space
bar when you have finished reading a page, in order to see the next page
(or press return to see one more line).  At the end of the section,  you
may press return to go back to the contents page.

The manual is organised in short sections, each at  most  two  or  three
screenfulls long.  Where a section would otherwise be too long to fit in
with this philosophy, the  manual  is  organised  recursively  and  will
display a subsidiary contents page, with a list of numbered subsections,
which you may read, as before, by typing  the  appropriate  number.   To
return  to  the  main  menu from a submenu, press return with no section
number, in response to the question at the bottom of the page.

The manual is intended to provide online documentation  of  the  Miranda
programming language and the command system in which it is embedded.  It
is not intended to be a tutorial on functional programming.  It does not
provide  information  about  the  operating  system,  for which separate
documentation is available (but there is a section on  the  Miranda/UNIX
interface).

------------------------------------------------------------------------
_S_u_m_m_a_r_y_ _o_f_ _m_a_n_u_a_l_ _b_e_h_a_v_i_o_u_r_:

Whenever the manual system prompts the user for input -  by  asking  for
"next selection" - the complete repertoire of possible responses is:

q 	   quit the manual
<return>   exit one level of menu structure
		(i.e. if at foot of section, return to menu
		      if at submenu, return to master menu
		      if at main menu, quit the manual)
<number>   display section from current contents page
.  	   (dot) same again, i.e. redisplay last requested section 
+  	   display next section in numerical order
-          display previous section
!command   temporary escape to O/S, executes shell command

------------------------------------------------------------------------
_S_u_m_m_a_r_y_ _o_f_ _t_h_e_ _b_e_h_a_v_i_o_u_r_ _o_f_ _`_m_o_r_e_'_:

Individual sections of the manual are displayed to you  using  the  UNIX
program  `more'  or an equivalent such as `less' (you can change this by
setting an environment variable VIEWER (*)).  These programs have  their
own  UNIX  manual page describing their features.  The responses you can
give generally include

[SPACE]	   display next screenful
[return]   display one more line
q          (quit) cease showing me this file
b          (back) scroll backwards by one screenful
/context   search for context (eg a word)
?context   search backwards for context
h          help

(*) See the section on Environment Variables under  UNIX/Miranda  system
interface.