Skip to content

Latest commit

 

History

History
118 lines (82 loc) · 5.77 KB

hbrun.en.md

File metadata and controls

118 lines (82 loc) · 5.77 KB
Raw

Harbour Shell / Script Runner 3.4.0dev (c390da90ad) (2017-10-10 16:11)
Copyright © 2007-present, Viktor Szakats
Copyright © 2003-2007, Przemysław Czerpak
https://github.com/vszakats/hb/

Syntax:

hbrun <file[.hb|.prg|.hrb|.dbf]|-dbf:file|-prg:string>|<option> [<parameter[s]>]

Description:

hbrun is able to run Harbour scripts (both source and precompiled), and it also features an interactive shell prompt.

Options below are available on command-line:

  • --hb:debug enable script debugging

  • -help this help

  • -viewhelp full help in text viewer

  • -fullhelp full help

  • -fullhelpmd full help in Markdown format

  • -version display version header only

Files:

  • *.hb Harbour script
  • *.hrb Harbour portable binary (aka precompiled Harbour script)
  • hbstart.hb startup Harbour script for interactive Harbour shell. It gets executed automatically on shell startup, if present. Possible locations (in order of precedence) [*]: ./, $HOME/.harbour, /etc/harbour, etc/harbour, etc, <hbrun directory>
  • shell plugins .hb and .hrb plugins for interactive Harbour shell. They may reside in [*]: $HOME/.harbour/
  • .hb_history stores command history for interactive Harbour shell. You can disable history by making the first line 'no' (without quotes and with newline). Resides in [*]: $HOME/.harbour/
  • hb_extension list of extensions to load in interactive Harbour shell. One extension per line, part of line beyond a '#' character is ignored. Alternate filename on MS-DOS: hb_ext.ini. Resides in [*]: $HOME/.harbour/

Predefined constants in sources (do not define them manually):

  • __HBSCRIPT__HBSHELL when a Harbour source file is run as a shell script
  • <standard Harbour> __PLATFORM__*, __ARCH*BIT__, __*_ENDIAN__, etc.

Environment variables:

  • HB_EXTENSION space separated list of extensions to load in interactive Harbour shell

Shell API available in Harbour scripts:

  • hbshell_gtSelect( [<cGT>] ) -> NIL
    Switch GT. Default [*]: 'gttrm'
  • hbshell_Clipper() -> NIL
    Enable Cl*pper compatibility (non-Unicode) mode.
  • hbshell_include( <cHeader> ) -> <lSuccess>
    Load Harbour header.
  • hbshell_uninclude( <cHeader> ) -> <lSuccess>
    Unload Harbour header.
  • hbshell_include_list() -> NIL
    Display list of loaded Harbour header.
  • hbshell_ext_load( <cPackageName> ) -> <lSuccess>
    Load package. Similar to #request PP directive.
  • hbshell_ext_unload( <cPackageName> ) -> <lSuccess>
    Unload package.
  • hbshell_ext_get_list() -> <aPackages>
    List of loaded packages.
  • hbshell_DirBase() -> <cBaseDir>
    hb_DirBase() not mapped to script.
  • hbshell_ProgName() -> <cPath>
    hb_ProgName() not mapped to script.
  • hbshell_ScriptName() -> <cPath>
    Name of the script executing.

Notes:

  • .hb, .prg, .hrb or .dbf file passed as first parameter will be run as Harbour script. If the filename contains no path components, it will be searched in current working directory and in PATH. If not extension is given, .hb and .hrb extensions are searched, in that order. .dbf file will be opened automatically in shared mode and interactive Harbour shell launched. .dbf files with non-standard extension can be opened by prepending '-dbf:' to the file name. Otherwise, non-standard extensions will be auto-detected for source and precompiled script types. Note, for Harbour scripts, the codepage is set to UTF-8 by default. The default core header 'hb.ch' is automatically #included at the interactive shell prompt. The default date format is the ISO standard: yyyy-mm-dd. SET EXACT is set to ON. Set( _SET_EOL ) is set to OFF. The default GT is 'gtcgi', unless full-screen CUI calls are detected, when 'gttrm' [*] is automatically selected (except for INIT PROCEDUREs).
  • You can use key <Ctrl+V> in interactive Harbour shell to paste text from the clipboard.
  • Values marked with [*] may be host platform and/or configuration dependent. This help was generated on 'darwin' host platform.

License:

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software Foundation,
Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
(or visit their website at https://www.gnu.org/licenses/\).

License extensions:

  • This source code must be kept and distributed as part
    of the Harbour package and/or the placement of the tool sources
    and files must reflect that it is part of Harbour Project.
  • Copyright information must always be presented by
    projects including this tool or help text.
  • Modified versions of the tool must clearly state this
    fact on the copyright screen.
  • Source code modifications shall always be made available
    along with binaries.
  • Help text and documentation is licensed under
    Creative Commons Attribution-ShareAlike 4.0 International:
    https://creativecommons.org/licenses/by-sa/4.0/

Author:

  • Viktor Szakats