github.com/PDP-10.its
1
0
Fork 0
mirror of https://github.com/PDP-10/its.git synced 2026-02-05 08:04:38 +00:00
Code Issues Releases Wiki Activity

Generate INFO; INFO > from INFO; INFOD >.

Browse Source
This commit is contained in:
Lars Brinkhoff
2018-11-09 15:32:09 +01:00
parent 0d386d31fd
commit 9720c349fe
2 changed files with 67 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

98
doc/info/info.47 → doc/info/infod.10 Executable file → Normal file
View File

@@ -1,3 +1,11 @@
-*-Text-*-
DOCOND declarations for operating-system dependencies.
{Alternatives:ITS,Twenex}
{Flag:?ITS}
{Flag:?Twenex}
{Replace:+Twenex=>DDT->the EXEC}
{Replace:+Twenex=>:INFO->XINFO}
{end}
This file documents the INFO program. -*-Text-*-
The H command of INFO goes to the node Help in this file.
Do NOT edit this file! It is produced by DOCOND from the file INFOD.
@@ -6,9 +14,9 @@ File: INFO Node: Top Up: (DIR) Next: Add
INFO is a program for reading documentation, which you are using now.
INFO is invoked as a separate program with :INFO<CR> from DDT. INFO
can be run inside an EMACS editor with MM INFO, or, in the default
enviroment, C-X I.
INFO is invoked as a separate program with :INFO<CR>
from DDT. INFO can be run inside an EMACS editor with MM INFO, or,
in the default enviroment, C-X I.{*Refill:}
To learn how to use INFO, type the command "H". It will bring you
to a programmed instruction sequence.
@@ -24,8 +32,8 @@ to a programmed instruction sequence.
* Footnotes:: How to add footnotes to info nodes.
* Tags:: How to make tag tables for INFO files.
* Checking:: How to check the consistency of an INFO file.
* Installing:: How to install a modified INFO file.
{+ITS:* Installing:: How to install a modified INFO file.
}

File: INFO Node: Help-Small-Screen Next: Help
@@ -370,8 +378,9 @@ then move on with "N".

Node: Help-Pr-Q, Previous: Help-Pr-Footnotes
To get out of Info, back to either DDT (if you did :INFO from DDT)
or to EMACS (if you did MM Info from EMACS), type "Q" for "Quit".
To get out of Info, back to either DDT (if you did
:INFO from DDT) or to EMACS (if you did MM Info
from EMACS), type "Q" for "Quit".{*Refill:}
This is the end of the course on using INFO. There are some other
commands that are not essential or meant for experienced users; they
@@ -663,8 +672,9 @@ In general, the "L" command is the only way to get back there.

File: INFO Node: Help-Q Previous: Help-Adv Up: Top
To get out of Info, back to either DDT (if you did :INFO from DDT)
or to EMACS (if you did MM Info from EMACS), type "Q" for "Quit".
To get out of Info, back to either DDT (if you did
:INFO from DDT) or to EMACS (if you did MM Info
from EMACS), type "Q" for "Quit".{*Refill:}
This is the end of the course on using INFO. There are some other
commands that are not essential or meant for experienced users; they
@@ -680,8 +690,8 @@ File: INFO Node: Add Up: Top Next: Menus
To add a new topic to the list in the directory, you must
1) create a node, in some file, to document that topic.
2) put that topic in the menu in the directory. *Note Menu: Menus.
3) install it on all five machines. *Note Installing: Installing.
{+ITS: 3) install it on all five machines. *Note Installing: Installing.
}
The new node can live in an existing documentation file, or in a new
one. It must have a ^_ before it (invisible to the user; this node
has one but you can't see it), and it ends with either a ^_, a ^L, or
@@ -710,20 +720,21 @@ insignificant.
what appears after the "Node: " in that node's first line. For
example, this node's name is "ADD". A node in another file is named
by "(filename)node-within-file", as in "(INFO)ADD" for this node. The
default names for files are DSK:INFO;... >. Parts of the filename
which are the same as the default should be omitted for clarity;
usually, just the first name of the file suffices. The name
"(filename)Top" can be abbreviated to just "(filename)". By
default names for files are {+ITS:DSK:INFO;... >}{+Twenex:<INFO>.INFO}.
Parts of the filename which are the same as the default should be
omitted for clarity; usually, just the first name of the file suffices.
The name "(filename)Top" can be abbreviated to just "(filename)". By
convention, the name "Top" is used for the "highest" node in any
single file - the node whose "Up" points out of the file. The
Directory node is "(DIR)". The Top node of a document file listed in
the Directory should have an "Up: (DIR)" in it.
the Directory should have an "Up: (DIR)" in it.{*Refill:}
The node name "*" is special - it refers to the entire file. Thus,
G* will show you the whole current file. The use of the node * is to
make it possible to make old-fashioned, unstructured files into nodes
of the tree. .INFO.;FOO ORDER can be made into a subnode by putting
"(.INFO.;FOO ORDER)*" into a menu!
of the tree. {+ITS:.INFO.;FOO ORDER}{+Twenex:<INFO>FOO.INFO} can be
made into a subnode by putting "({+ITS:.INFO.;FOO
ORDER}{+Twenex:FOO})*" into a menu!{*Refill:}
The "Node:" name, in which a node states its own name, must not
contain a filename, since INFO when searching for a node does not
@@ -770,11 +781,13 @@ subnodes in a sequence of Next's/Previous's so that someone who
wants to see them all need not keep revisiting the Menu.
The INFO Directory is simply the menu of the node "(DIR)TOP" - that
is, node Top in file INFO;DIR >. You can put new entries in that menu
just like any other menu. The INFO Directory is NOT the same as the
is, node Top in file {+ITS:INFO;DIR >}{+Twenex:<INFO>DIR.INFO}. You can
put new entries in that menu just like any other menu. The INFO
Directory is NOT the same as the
file directory called INFO. It happens that many of INFO's files live
on that file directory, but they don't have to; and files on that
directory are not automatically listed in the INFO Directory node.
directory are not automatically listed in the INFO Directory
node.{*Refill:}
Also, although the INFO node graph is claimed to be a "Hierarchy",
in fact it can be ANY directed graph. Shared structures and
@@ -815,7 +828,7 @@ an INFO file lives inside the file itself and will automatically be
used whenever INFO reads in the file. For information on how to
construct and update the tag table, see *Note Tags: (TAGS)INFO.

File: INFO, Node: Checking, Previous: Tags, Up: Top, Next: Installing
File: INFO, Node: Checking, Previous: Tags, Up: Top{+ITS:, Next: Installing}
Checking an INFO File:
@@ -833,23 +846,23 @@ to other files would be terribly slow. But those are usually few.
To check an INFO file, do M-X RunINFOCheck INFO File<cr> with the
INFO file visited in EMACS, or do X Check INFO File<cr> while looking
at a node in the file with INFO.

 {+ITS:
File: INFO, Node: Installing, Up: Top, Previous: Checking
How to Install a New INFO Directory on All Machines:
There are five ITS machines (AI, MC, MX, ML, and MD) and each one has
its own copy of the directory file INFO;DIR >. These files should all be
identical and have the same version number. Whenever the directory is
changed on one machine it should be changed on all machines at the same
time. This is done by editing the directory on one machine and then
copying the file to the other machines.
There are five ITS machines (AI, MC, MX, ML and MD) and each one has
its own copy of the directory file INFO;DIR >. These files should all
be identical and have the same version number. Whenever the directory
is changed on one machine it should be changed on all machines at the
same time. This is done by editing the directory on one machine and
then copying the file to the other machines.
The reason for this is that it is much easier to edit the directory once
and copy it than to edit five different directories. In order for us to
continue to be able to edit only once, we must make sure that the five
directories remain the same, which means EVERYONE must install his changes
on all machines.
The reason for this is that it is much easier to edit the directory
once and copy it than to edit five different directories. In order
for us to continue to be able to edit only once, we must make sure
that the five directories remain the same, which means EVERYONE must
install his changes on all machines.
The easiest way to copy the file to all the other machines is to do
@@ -871,7 +884,7 @@ machines if you like, but advertise that fact widely; otherwise
someone else may edit the file on one machine and copy it around.
If you work on an INFO file about general parts of the system, then it
should certainly be maintained identical on all machines.

 }
File: INFO Node: Printing Up: Top
Using INFO on a printing terminal.
@@ -924,7 +937,8 @@ while you are typing the argument in.
To go to a node in another file, you can include the filename in the
node name by putting it at the front, in parentheses. Thus,
"G(DIR)Top<CR>" would go to the INFO Directory node, which is node Top
in the file DIR (which is short for DSK:INFO;DIR >).
in the file DIR (which is short for {+ITS:DSK:INFO;DIR
>}{+Twenex:<INFO>DIR.INFO}).{*Refill:}
The node name "*" specifies the whole file. So you can look at all
of the current file by typing "G*<CR>" or all of any other file
@@ -960,12 +974,12 @@ name than counting.
The INFO command "" enters a recursive editing level for you to edit
the text of the current node. To get back to INFO, you must give a
command to exit. This command is C-M-C unless your init file
redefines it. If you have changed the text of the node, then when you
visit a node in a different file INFO will offer to save this file.
This is because INFO just uses C-X C-V to access files. You can also
save the file explicitly by using the C-X C-S command or equivalent
while you are still inside the recursive edit.
command to exit. This command is {+ITS:C-M-C}{+Twenex:C-M-Z} unless
your init file redefines it. If you have changed the text of the
node, then when you visit a node in a different file INFO will offer
to save this file. This is because INFO just uses C-X C-V to access
files. You can also save the file explicitly by using the C-X C-S
command or equivalent while you are still inside the recursive edit.{*Refill:}

File: INFO Node: ARG Up: Top