core/builtins/console.cif
author Joe Branton <joe.branton@accenture.com>
Thu, 29 Jul 2010 12:58:05 +1000
changeset 17 949c6f5096e4
parent 0 7f656887cf89
child 75 3c3961c1ae26
permissions -rw-r--r--
More build fixes. Changed the documentation builder to automatically prepend %EPOCROOT% (converted to a path relative form) to pre-processor include path options that start with 'epoc32'. Prevously $(EPOCROOT) was prepended in the makefile, which broke the documentation build because the pre-processor will only accecpt relative path include options.

# console.cif
# 
# Copyright (c) 2010 Accenture. All rights reserved.
# This component and the accompanying materials are made available
# under the terms of the "Eclipse Public License v1.0"
# which accompanies this distribution, and is available
# at the URL "http://www.eclipse.org/legal/epl-v10.html".
# 
# Initial Contributors:
# Accenture - Initial contribution
#

==name console

==short-description

Displays the name (and optionally other details) of the console implementation that L<fshell|fshell> is attached to.

==long-description

Note, fshell provides various console implementations. See the F<Consoles> section of the fshell's documentation for details.

==see-also

L<pcons|pcons>, L<ioinfo|ioinfo>

==option bool v verbose

Display verbose information.

==option bool r remote

Return zero if the console implementation is remotely hosted (i.e. F<rcons.dll> or one of the VT100 console variants), non-zero if it isn't.

==option bool n null

Return zero if the console implementation is F<nullcons.dll>.

==copyright

Copyright (c) 2006-2010 Accenture. All rights reserved.