agr(1) - f36

1agr(1)                      General Commands Manual                     agr(1)
2
3
4

NAME

6       agr - Displays AmigaGuide files in a terminal
7

SYNOPSIS

9       agr guidefile
10

DESCRIPTION

12       AmigaGuide Reader (agr for short) is a command line program for viewing
13       AmigaGuide files, the native documentation format commonly used on  the
14       Amiga  platform and its clones. It supports the complete v39 specifica‐
15       tion and a significant part of the v40 specification. AmigaGuide  files
16       traditionally use the .guide filename suffix.
17

OPTIONS

19       None
20

USAGE

22       In  summary,  agr primarily uses the TAB, CURSOR, SPACE and RETURN keys
23       for navigation. An exhaustive list follows.
24
25       q or ^C
26              Quits agr.
27
28       CURSOR keys or i,j,k,l
29              Scroll the document up, down, left or right in cases where it is
30              wider or longer than your terminal
31
32       PAGE UP/PAGE DOWN
33              Scrolls  the  document up or down by one complete page, equal to
34              the height of your terminal.
35
36       HOME or g
37              Jumps to the top of the document node.
38
39       END or G
40              Jumps to the bottom of the document node.
41
42       SPACE or RETURN
43              Display the highlighted document node link.
44
45       TAB    Highlight the next visible node link.
46
47       a      Highlight the previous visible node link.
48
49       F1     Display the Help Node if the AmigaGuide file has one defined. If
50              you  are  using a terminal emulator under X(1), it may trap this
51              key rendering it unavailable.
52
53       F2     Display the Index Node if the AmigaGuide file has one defined.
54
55       F3     Display the Table of Contents Node if the  AmigaGuide  file  has
56              one defined.
57
58       n/b    Display  the  next   or previous document node. Please note, the
59              next or previous document node does not follow the logical  lay‐
60              out of the AmigaGuide document as it is displayed, but refers to
61              the next or previous document node as  sequentially  written  in
62              the AmigaGuide file.
63
64       +/-    Increase or decrease the TAB size (tabstop) by the equivalent of
65              one space.
66
67       t      Display the current TAB size (tabstop) in the lower  right  hand
68              corner.
69
70       r      Refresh the display.
71
72       ?      Display any meta data stored in the AmigaGuide file.
73
74       v      Displays the contents of any broken links.
75
76       =      Displays the current line number in the lower right hand corner.
77
78       C      Attempt to use native Amiga colouring for coloured text.
79
80              ANSI  colours  on the Amiga are not standardised but depend upon
81              the current colourmap and palette  in  use.  Thus  if  the  user
82              changes  the colours used by their desktop environment, the ANSI
83              colours change too. This command attempts to convert the colours
84              displayed  in  agr from standard ANSI colours to those one would
85              see by default on AmigaOS 2.0+. See the conversion table below.
86
87              Colour Table
88                     #: ANSI       Amiga
89                     ------------------------
90                     0: Black   -> Light Grey
91                     1: Red     -> Black
92                     2: Green   -> White
93                     3: Yellow  -> Light Blue
94                     4: Blue    -> Yellow
95                     5: Magenta -> Blue
96                     6: Cyan    -> Green
97                     7: White   -> Red
98

AUTHOR

100       Written by Thierry Pierron.
101       Additional patches by Hans de Goede.
102       This man page was written by Ian Chapman.
103

BUGS

105       Does not support the complete v40 specification.
106       AREXX node links are not supported (rarely used feature).
107       System command node links are not supported (rarely used feature).
108
109       This software is not actively updated, but patches  or  bug  fixes  are
110       welcome and should be sent to <packages@amiga-hardware.com>.
111

CAVEATS

113       Amiga  filepaths  are similar but differ slightly from UNIX file paths.
114       In some cases this may lead to external files referenced  by  the  Ami‐
115       gaGuide  file  as not being found. However agr tries several techniques
116       to avoid this.
117
118       Amiga filenames are case insensitive so unless  the  correct  case  has
119       been  used  in the AmigaGuide file, externally referenced files may not
120       be found.
121