|
oddsocks |
fcbe9fb |
.TH "agr" 1
|
|
oddsocks |
fcbe9fb |
.SH NAME
|
|
oddsocks |
fcbe9fb |
agr \- Displays AmigaGuide files in a terminal
|
|
oddsocks |
fcbe9fb |
.SH SYNOPSIS
|
|
oddsocks |
fcbe9fb |
.B agr
|
|
oddsocks |
fcbe9fb |
.I guidefile
|
|
oddsocks |
fcbe9fb |
.SH DESCRIPTION
|
|
oddsocks |
fcbe9fb |
AmigaGuide Reader (\fBagr\fR for short) is a command line program for viewing
|
|
oddsocks |
fcbe9fb |
AmigaGuide files, the native documentation format commonly used on the Amiga
|
|
oddsocks |
fcbe9fb |
platform and its clones. It supports the complete v39 specification and a
|
|
oddsocks |
fcbe9fb |
significant part of the v40 specification. AmigaGuide files traditionally use
|
|
oddsocks |
fcbe9fb |
the .guide filename suffix.
|
|
oddsocks |
fcbe9fb |
.SH OPTIONS
|
|
oddsocks |
fcbe9fb |
.TP
|
|
oddsocks |
fcbe9fb |
None
|
|
oddsocks |
fcbe9fb |
.SH USAGE
|
|
oddsocks |
fcbe9fb |
.PP
|
|
oddsocks |
fcbe9fb |
In summary, \fBagr\fR primarily uses the TAB, CURSOR, SPACE and RETURN keys for
|
|
oddsocks |
fcbe9fb |
navigation. An exhaustive list follows.
|
|
oddsocks |
fcbe9fb |
.IP "q or ^C"
|
|
oddsocks |
fcbe9fb |
Quits \fBagr\fR.
|
|
oddsocks |
fcbe9fb |
.IP "CURSOR keys or i,j,k,l"
|
|
oddsocks |
fcbe9fb |
Scroll the document up, down, left or right in cases where it is wider or
|
|
oddsocks |
fcbe9fb |
longer than your terminal
|
|
oddsocks |
fcbe9fb |
.IP "PAGE UP/PAGE DOWN"
|
|
oddsocks |
fcbe9fb |
Scrolls the document up or down by one complete page, equal to the height of
|
|
oddsocks |
fcbe9fb |
your terminal.
|
|
oddsocks |
fcbe9fb |
.IP "HOME or g"
|
|
oddsocks |
fcbe9fb |
Jumps to the top of the document node.
|
|
oddsocks |
fcbe9fb |
.IP "END or G"
|
|
oddsocks |
fcbe9fb |
Jumps to the bottom of the document node.
|
|
oddsocks |
fcbe9fb |
.IP "SPACE or RETURN"
|
|
oddsocks |
fcbe9fb |
Display the highlighted document node link.
|
|
oddsocks |
fcbe9fb |
.IP "TAB"
|
|
oddsocks |
fcbe9fb |
Highlight the next visible node link.
|
|
oddsocks |
fcbe9fb |
.IP "a"
|
|
oddsocks |
fcbe9fb |
Highlight the previous visible node link.
|
|
oddsocks |
fcbe9fb |
.IP "F1"
|
|
oddsocks |
fcbe9fb |
Display the Help Node if the AmigaGuide file has one defined. If you are using a
|
|
oddsocks |
fcbe9fb |
terminal emulator under \fBX\fR(1), it may trap this key rendering it unavailable.
|
|
oddsocks |
fcbe9fb |
.IP "F2"
|
|
oddsocks |
fcbe9fb |
Display the Index Node if the AmigaGuide file has one defined.
|
|
oddsocks |
fcbe9fb |
.IP "F3"
|
|
oddsocks |
fcbe9fb |
Display the Table of Contents Node if the AmigaGuide file has one defined.
|
|
oddsocks |
fcbe9fb |
.IP "n/b"
|
|
oddsocks |
fcbe9fb |
Display the next or previous document node. Please note, the next or previous
|
|
oddsocks |
fcbe9fb |
document node does not follow the logical layout of the AmigaGuide document as
|
|
oddsocks |
fcbe9fb |
it is displayed, but refers to the next or previous document node as
|
|
oddsocks |
fcbe9fb |
sequentially written in the AmigaGuide file.
|
|
oddsocks |
fcbe9fb |
.IP "+/-"
|
|
oddsocks |
fcbe9fb |
Increase or decrease the TAB size (tabstop) by the equivalent of one space.
|
|
oddsocks |
fcbe9fb |
.IP "t"
|
|
oddsocks |
fcbe9fb |
Display the current TAB size (tabstop) in the lower right hand corner.
|
|
oddsocks |
fcbe9fb |
.IP "r"
|
|
oddsocks |
fcbe9fb |
Refresh the display.
|
|
oddsocks |
fcbe9fb |
.IP "?"
|
|
oddsocks |
fcbe9fb |
Display any meta data stored in the AmigaGuide file.
|
|
oddsocks |
fcbe9fb |
.IP "v"
|
|
oddsocks |
fcbe9fb |
Displays the contents of any broken links.
|
|
oddsocks |
fcbe9fb |
.IP "="
|
|
oddsocks |
fcbe9fb |
Displays the current line number in the lower right hand corner.
|
|
oddsocks |
fcbe9fb |
.IP "C"
|
|
oddsocks |
fcbe9fb |
Attempt to use native Amiga colouring for coloured text.
|
|
oddsocks |
fcbe9fb |
.sp
|
|
oddsocks |
fcbe9fb |
ANSI colours on the Amiga are not standardised but depend upon the current
|
|
oddsocks |
fcbe9fb |
colourmap and palette in use. Thus if the user changes the colours used by
|
|
oddsocks |
fcbe9fb |
their desktop environment, the ANSI colours change too. This command attempts
|
|
oddsocks |
fcbe9fb |
to convert the colours displayed in \fBagr\fR from standard ANSI colours to
|
|
oddsocks |
fcbe9fb |
those one would see by default on AmigaOS 2.0+. See the conversion table below.
|
|
oddsocks |
fcbe9fb |
.RS
|
|
oddsocks |
fcbe9fb |
.IP "Colour Table"
|
|
oddsocks |
fcbe9fb |
#: ANSI Amiga
|
|
oddsocks |
fcbe9fb |
.br
|
|
oddsocks |
fcbe9fb |
------------------------
|
|
oddsocks |
fcbe9fb |
.br
|
|
oddsocks |
fcbe9fb |
0: Black -> Light Grey
|
|
oddsocks |
fcbe9fb |
.br
|
|
oddsocks |
fcbe9fb |
1: Red -> Black
|
|
oddsocks |
fcbe9fb |
.br
|
|
oddsocks |
fcbe9fb |
2: Green -> White
|
|
oddsocks |
fcbe9fb |
.br
|
|
oddsocks |
fcbe9fb |
3: Yellow -> Light Blue
|
|
oddsocks |
fcbe9fb |
.br
|
|
oddsocks |
fcbe9fb |
4: Blue -> Yellow
|
|
oddsocks |
fcbe9fb |
.br
|
|
oddsocks |
fcbe9fb |
5: Magenta -> Blue
|
|
oddsocks |
fcbe9fb |
.br
|
|
oddsocks |
fcbe9fb |
6: Cyan -> Green
|
|
oddsocks |
fcbe9fb |
.br
|
|
oddsocks |
fcbe9fb |
7: White -> Red
|
|
oddsocks |
fcbe9fb |
.SH AUTHOR
|
|
oddsocks |
fcbe9fb |
.PP
|
|
oddsocks |
fcbe9fb |
Written by Thierry Pierron.
|
|
oddsocks |
fcbe9fb |
.br
|
|
oddsocks |
fcbe9fb |
Additional patches by Hans de Goede.
|
|
oddsocks |
fcbe9fb |
.br
|
|
oddsocks |
fcbe9fb |
This man page was written by Ian Chapman.
|
|
oddsocks |
fcbe9fb |
.SH BUGS
|
|
oddsocks |
fcbe9fb |
.PP
|
|
oddsocks |
fcbe9fb |
Does not support the complete v40 specification.
|
|
oddsocks |
fcbe9fb |
.br
|
|
oddsocks |
fcbe9fb |
AREXX node links are not supported (rarely used feature).
|
|
oddsocks |
fcbe9fb |
.br
|
|
oddsocks |
fcbe9fb |
System command node links are not supported (rarely used feature).
|
|
oddsocks |
fcbe9fb |
.PP
|
|
oddsocks |
fcbe9fb |
This software is not actively updated, but patches or bug fixes are welcome and
|
|
oddsocks |
fcbe9fb |
should be sent to <packages@amiga\-hardware.com>.
|
|
oddsocks |
fcbe9fb |
.SH CAVEATS
|
|
oddsocks |
fcbe9fb |
.PP
|
|
oddsocks |
fcbe9fb |
Amiga filepaths are similar but differ slightly from UNIX file paths. In some
|
|
oddsocks |
fcbe9fb |
cases this may lead to external files referenced by the AmigaGuide file as not
|
|
oddsocks |
fcbe9fb |
being found. However \fBagr\fR tries several techniques to avoid this.
|
|
oddsocks |
fcbe9fb |
.PP
|
|
oddsocks |
fcbe9fb |
Amiga filenames are case insensitive so unless the correct case has been used
|
|
oddsocks |
fcbe9fb |
in the AmigaGuide file, externally referenced files may not be found.
|
|
oddsocks |
fcbe9fb |
.SH "SEE ALSO"
|
|
oddsocks |
fcbe9fb |
.PP
|
|
oddsocks |
fcbe9fb |
The full documentation for \fBagr\fR is available as an HTML file in addition to an
|
|
oddsocks |
fcbe9fb |
AmigaGuide file which should have been installed alongside agr.
|