COMMENT(-- $Id: aterm-options.yo,v 1.1.1.1 2001/03/11 07:50:05 sashav Exp $ --)
COMMENT(----------------------------------------------------------------------)
manpageoptions()

The bf(aterm) options (mostly a subset of em(xterm)'s) are listed below.
In keeping with the smaller-is-better philosophy, options may be eliminated
or default values chosen at compile-time, so options and defaults listed
may not accurately reflect the version installed on your system.

Note that bf(aterm) permits the resource name to be used as a long-option
(--/++ option) so the potential command-line options are far greater than
those listed.
For example: `aterm --loginShell --color1 Orange'.

startdit()
    dit(bf(-help), bf(--help))
	Print out a message describing available options.
    dit(bf(-version), bf(--version))
	Print out a version with/without list of available options.
    dit(bf(-display) em(displayname))
	Attempt to open a window on the named X display (bf(-d) still
	respected).  In the absence of this option, the display specified
	by the bf(DISPLAY) environment variable is used.
    dit(bf(-geometry) em(geom))
	Window geometry (-g still respected);
        resource bf(geometry).
    dit(bf(-rv)|bf(+rv))
	Turn on/off simulated reverse video;
        resource bf(reverseVideo).
    dit(bf(-bg) em(colour))
	Window background colour;
        resource bf(background).
    dit(bf(-fg) em(colour))
	Window foreground colour;
	resource bf(foreground).
    dit(bf(-pixmap:) em(file[;geom]))
	Specify image file for the background and also optionally specify 
	geometry of the image to be cut out of original image, to be used
	as background, with a geometry string.  Note you may need to add 
	quotes to avoid special shell interpretation of the `;' in the 
	command-line;
	resource bf(backgroundPixmap).
    dit(bf(-mst:) em(name))
	Specify the name of the Afterstep MyStyle to be used as the base of
	aterm's look. ForeColor, BackColor, Font, BackPixmap (all texture 
	options) will be used from MyStyle definition, unless some other 
	command line option is specifyed for the same setting. 
	For example -fn will override MyStyle Font. This is available only 
	if used with AfterStep 1.9.28 or later and if compiled with AfterStep 
	libraries support ( --enable-afterstep-lib).
	resource bf(MyStyle).
    dit(bf(-tr)|bf(+tr))
	Turn on/off pseudo transparency mode. In this mode bf(aterm)
	will use part of root background as it's own background, emulating
	see-through effect;
	resource bf(transparent).
    dit(bf(-trsb)|bf(+trsb))
	Turn on/off pseudo transparent scrollbar. Works the same as -tr;
	resource bf(transpscrollbar).
    dit(bf(-tint) em(color))
	Turn on pseudo transparency background tinting. Tinting can be done
	fast and slow way. In fast way it will be done by combining of background
	color with tinting color using logical function. This function defaults
	to AND, and it can be changed using bf(-tinttype) option - see below.
	In general solid colors like Blue, Red, Green, Cyan, Magenta, Yellow 
	are good, but you should experiment with it for each background you have.
	True tinting is more memory and CPU hungry - tinted copy of background 
	image will be created every time you move/resize window. It alows for more 
	smooth tinting thou.
	You need to build it with bf(--enable-transparency=yes) or 
	bf(--enable-background-imageyes) option, to be able to use this feature.
	resource bf(tinting).	
    dit(bf(-sh) em(amount))
	This option allows for darkening/lightening of the background image
	em(amount) is the %value of the desired brightness, where 100 is the 
	original.
	if em(amount) is less then 100 - image will be darkened.
	if em(amount) is less then 0 or more then 100 - image will be lightened.
	Lightening can cause some strange looking effects if applied on bright image.
	This option causes aterm to create shaded/lightened copy of the background - 
	it's more memory cosuming as the result. It does not make much difference,
	though, if applied on non transparent background image. 
	resource bf(shading).	
    dit(bf(-fade) em(amount))
	This option allows for darkening/lightening of colors when aterm is 
	loosing focus.
	em(amount) is the %value of the desired brightness, where 100 is the 
	original.
	if em(amount) is less then 100 - colors will be darkened.
	if em(amount) is less then 0 or more then 100 - colors will be lightened.
	Lightening can cause some strange looking effects if applied on bright colors.
	This option causes aterm to use more colors, as the result it is disabled by
	default. Use --enable-fading ./configure option to enable it. 
	resource bf(fading).	
    dit(bf(-bgtype) em(type))
        Specify type of the transformation to be performed on background 
	image. Possible types are :
	bf(tile) - plain vanilla tiling of the image.
	bf(scale) - original image will be scaled to the aterm's size, every
	  time you resize window.
	bf(scalev) - original image will be scaled to the aterm's height only,
	  every time you resize window.
	bf(scaleh) - original image will be scaled to the aterm's width only,
	  every time you resize window.
	bf(center) - original image will be centered in aterm's window.
	bf(notile) - background color will be padded to image's right/bottom 
	  to make it the same size as window is. 
	bf(notileh) - background color will be padded to image's right 
	  to make it the same width as window is. 
	bf(notilev) - background color will be padded to image's bottom 
	  to make it the same height as window is. 	
	bf(cut) - aterm background will be cut out of the source image,
	  as if this source image was tiled across the root window. The
	  portion of the image that lies underneath of window will be used. 	
	If AfterStep Pager, asetroot or Esetroot where used to set the root 
	image, then this option can be used in conjunction with -tr option.
	In this case it will do mentioned transformations to the root pixmap.
	and use it as aterm's background.  
	resource bf(backgroundType).
    dit(bf(-txttype) em(type))
	Allows you to specify logical function to be used when displaying 
	text. That will cause aterm to logically combine text with
	background pixels. That only works with transparent background 
	and background image. Possible values are :
	em(and), em(andReverse), em(andInverted), em(xor), em(or), em(nor),
	em(invert), em(equiv), em(invert), em(orReverse), em(orInverted), 
	em(nand);
	resource bf(textType).
    dit(bf(-tinttype) em(type))
	Allows you to specify logical function to be used when tinting 
	transparent background. That will cause aterm to logically combine
	text with background pixels. NOTE: If shading option is used, 
	or background image is specifyed - em(true) type will always be used.
	That works with bpth transparent background and background image. 
	Possible values are :
	
	Fast tinting options :
	em(and), em(andReverse), em(andInverted), em(xor), em(or), em(nor),
	em(invert), em(equiv), em(invert), em(orReverse), em(orInverted), 
	em(nand), 
	
	Slow tinting:
	em(true) - will do "true" tinting - that means that background pixel's 
	RGB components will be decreased proportionaly to the RGB components
	of specified tinting color;
	resource bf(tintingType).
    dit(bf(-cr) em(colour))
	The cursor colour;
	resource bf(cursorColor).
    dit(bf(-pr) em(colour))
	The mouse pointer colour;
	resource bf(pointerColor).
    dit(bf(-bd) em(colour))
	The colour of the border between the xterm scrollbar and the text;
	resource bf(borderColor).
    dit(bf(-bw) em(number))
        This option specifies the width in pixels of the border surrounding
	the window;
        resource bf(borderWidth).
    dit(bf(-fn) em(fontname))
	Main normal text font;
	resource bf(font).
    dit(bf(-fb) em(fontname))
	Main bold text font;
	resource bf(boldFont).
    dit(bf(-fm) em(fontname))
	Main multicharacter font;
	resource bf(mfont).
    dit(bf(-km) em(mode))
	Multiple-character font-set encoding mode;
	bf(eucj): EUC Japanese encoding.
	bf(sjis): Shift JIS encoding;
	resource bf(multichar_encoding).
    dit(bf(-grk) em(mode))
	Greek keyboard translation;
	bf(iso): ISO-8859 mapping.
	bf(ibm): IBM-437 mapping;
	resource bf(greek_keyboard).
    dit(bf(-name) em(name))
	Specify the application name under which resources
	are to be obtained, rather than the default executable file name.
	Name should not contain `.' or `*' characters.
	Also sets the icon and title name.
    dit(bf(-ls)|bf(+ls))
	Start as a login-shell/sub-shell;
	resource bf(loginShell).
    dit(bf(-ut)|bf(+ut))
	Inhibit/enable writing a utmp entry;
	resource bf(utmpInhibit).
    dit(bf(-vb)|bf(+vb))
	Turn on/off visual bell on receipt of a bell character;
	resource bf(visualBell).
    dit(bf(-sb)|bf(+sb))
	Turn on/off scrollbar;
	resource bf(scrollBar).
    dit(bf(-si)|bf(+si))
	Turn on/off scroll-to-bottom on TTY output inhibit;
	resource bf(scrollTtyOutput).
    dit(bf(-sk)|bf(+sk))
	Turn on/off scroll-to-bottom on keypress;
	resource bf(scrollKeypress).
    dit(bf(-sr)|bf(+sr)) 
	Put scrollbar on right/left;
	resource bf(scrollBar_right).
    dit(bf(-st)|bf(+st)) 
	Display scrollbar without/with a trough;
	resource bf(scrollBar_floating).
    dit(bf(-iconic)) 
	Start iconified, if the window manager supports that option.
    dit(bf(-sl) em(number))
	Save em(number) lines in the scrollback buffer;
	resource bf(saveLines).
    dit(bf(-tn) em(termname)) 
	This option specifies the name of the terminal type to be set in the
	bf(TERM) environment variable. This terminal type must exist in the
	em(termcap(5)) database and should have em(li#) and em(co#) entries;
	resource bf(termName).
    dit(bf(-e) em(command [arguments]))
	Run the command with its command-line arguments in the bf(aterm)
	window; also sets the window title and icon name to be the basename
	of the program being executed if neither em(-title) (em(-T)) nor
	em(-n) are given on the command line.  If this option is used, it
	must be the last on the command-line.  If there is no bf(-e) option
	then the default is to run the program specified by the bf(SHELL)
	environment variable or, failing that, em(sh(1)).
    dit(bf(-title) em(text))
	Window title bf(-T) still respected); the default title is the
	basename of the program specified after the \f3\-e\fP option, if
	any, otherwise the application name;
	resource bf(title).
    dit(bf(-n) em(text))
	Icon name; the default name is the basename of the program specified
	after the \f3\-e\fP option, if any, otherwise the application name;
	resource bf(iconName).
    dit(bf(-C)) Capture system console messages.

enddit()
