head	1.4;
access;
symbols
	NUTS333:1.4
	NUTS332:1.4
	NUTS331:1.3
	NUTS330:1.2
	NUTS321:1.1
	NUTS320:1.1;
locks; strict;
comment	@# @;


1.4
date	96.12.10.04.40.56;	author kcozens;	state Exp;
branches;
next	1.3;

1.3
date	96.12.09.07.27.18;	author kcozens;	state Exp;
branches;
next	1.2;

1.2
date	96.12.09.06.47.21;	author kcozens;	state Release;
branches;
next	1.1;

1.1
date	96.07.23.16.12.05;	author kcozens;	state Exp;
branches;
next	;


desc
@This is a sample help file for a command.
@


1.4
log
@Added some extra comments regarding the use of underlining on some terminals.
@
text
@
* colour *

This command toggles colour on and off. The colour itself is controlled by
embedded tags in text strings which all begin with a '~', eg /~FG.
They are the following...

Control tags...

  /~RS : Rest terminal to default state
  /~RV : ~RVReverse video
  /~OL : ~OLBold
  /~LI : ~LIBlink/flash text. This only works on some terminals, others may
        ~LIsimply display it as bold.
  /~UL : ~ULUnderline text. As with blink this doesn't work on all terminals,
	    ~ULsome just display it as bold.

Foreground colour tags...

  /~FK : Foreground black
  /~FM : ~FMMagenta/purple
  /~FR : ~FRRed
  /~FY : ~FYYellow/orange
  /~FG : ~FGGreen
  /~FB : ~FBBlue
  /~FT : ~FTTurquoise/bright blue
  /~FW : White

Background colour tags...

  /~BK : Background black
  /~BM : ~BMMagenta/purple
  /~BR : ~BRRed
  /~BY : ~BYYellow/orange
  /~BG : ~BGGreen
  /~BB : ~BBBlue
  /~BT : ~BTTurquoise/bright blue
  /~BW : White

So this: "/~FG/~BB/~LIhello world" would produce ~FG~BB~LIhello world

To display the colour tags as themselves without them producing a colour
prepend the ~ with a / , eg //~FG

@


1.3
log
@This file contained a '\' character instead of a '/'.
@
text
@d15 2
@


1.2
log
@Updated to give the details of the use of colour in messages.
@
text
@d5 1
a5 1
embedded tags in text strings which all begin with a '~', eg \~FG.
@


1.1
log
@Initial revision
@
text
@d4 38
a41 1
This command toggles colour on and off.
@
