Return to hconsole.1 CVS log

Up to [HATARI the Atari ST Emulator] / hatari / tools / hconsole

Annotation of hatari/tools/hconsole/hconsole.1, revision 1.1.1.1

1.1       root        1: .\" Hey, EMACS: -*- nroff -*-
                      2: .\" First parameter, NAME, should be all caps
                      3: .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
                      4: .\" other parameters are allowed: see man(7), man(1)
                      5: .TH "HCONSOLE" "1" "2010-10-10" "Hatari" "Hatari utilities"
                      6: .SH "NAME"
                      7: hconsole \- Interactive Python console for using Hatari's remote API
                      8: .SH "SYNOPSIS"
                      9: .B hconsole.py
                     10: .IR [[console options]
                     11: .IR [command file]
                     12: .B \-\-]
                     13: .IR [hatari options]
                     14: .SH "DESCRIPTION"
                     15: .I Hconsole
                     16: is a Python script that invokes Hatari and then provides an interactive
                     17: shell (with full readline editing capabilities) for executing Hatari
                     18: remote API commands.
                     19: .PP
                     20: It can be useful for first exploring Hatari's remote API usage
                     21: interactively and then writing scripts that somehow automate your
                     22: Hatari usage.  They can invoke hconsole functionality simply by doing
                     23: "import hconsole" and calling appropriate methods (see example.py
                     24: coming with hconsole).
                     25: .SH "USAGE"
                     26: Normally hconsole forwards  all of its arguments to Hatari instance
                     27: it invoked.  If you want to give arguments for hconsole itself,
                     28: you need to add '\-\-' argument after the hconsole arguments
                     29: and before the arguments going to Hatari.
                     30: .PP
                     31: If you give a file name as hconsole argument, commands in it will
                     32: be read and executed through Hatari's remote API before you get
                     33: into hconsole interactive shell.
                     34: .PP
                     35: Hconsole accepts following options:
                     36: .TP
                     37: .B \-\-exit
                     38: Exit after starting Hatari and parsing arguments.
                     39: .TP
                     40: .B \-\-help, \-h
                     41: Show command line help.
                     42: .SH "EXAMPLES"
                     43: Start Hatari with all of the given arguments:
                     44: .br
                     45:        hconsole.py \-\-monitor mono \-d test/
                     46: .PP
                     47: Start Hatari without extra arguments, execute commands from
                     48: the given commands.txt file, exit after the file ends:
                     49: .br
                     50:        hconsole.py commands.txt \-\-exit \-\-
                     51: .SH FILES
                     52: By default hconsole and its examples are installed under
                     53: the /usr/share/hatari/hconsole/ directory.
                     54: .SH "SEE ALSO"
                     55: .IR hatari (1),
                     56: .IR hatariui (1)
                     57: .SH "AUTHOR"
                     58: Written by Eero Tamminen <[email protected]>.
                     59: .SH "LICENSE"
                     60: This program is free software; you can redistribute it and/or modify
                     61: it under the terms of the GNU General Public License as published by
                     62: the Free Software Foundation; either version 2 of the License, or (at
                     63: your option) any later version.
                     64: .SH "NO WARRANTY"
                     65: This program is distributed in the hope that it will be useful, but
                     66: WITHOUT ANY WARRANTY; without even the implied warranty of
                     67: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
                     68: General Public License for more details.

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.