|
|
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 "hatariui" "1" "2010-05-30" "Hatari" "Hatari UI" ! 6: .SH "NAME" ! 7: hatariui \- Python/Gtk UI for Hatari ! 8: .SH "SYNOPSIS" ! 9: .B hatariui | hatariui.py ! 10: .RI [options] ! 11: .RI [diskimage] ! 12: .SH "DESCRIPTION" ! 13: .I hatariui ! 14: is a Python/Gtk UI for Hatari which can either embed the Hatari window ! 15: (on X11 systems) or run in a separate window. By default it provides ! 16: a normal application menu and some extra button for faster access to ! 17: fast-forward etc. functionality, but these are fully configurable ! 18: with the command line options. While it lacks support for some of ! 19: the Hatari configuration options that Hatari's SDL GUI has, it also ! 20: supports some options that the Hatari's built-in SDL UI doesn't. ! 21: .PP ! 22: Besides the UI configurability, some of the other advantages it has ! 23: over the SDL interface included with Hatari itself are use of a normal ! 24: Gtk file selector with all of its features (directory shortcuts etc), ! 25: support for UTF-8 (in file names) and in general blending better to ! 26: the user's desktop environment. ! 27: .PP ! 28: Additionally, Hatari can run while one uses UI configuration dialogs, ! 29: and it can stop Hatari completely to better save the battery on mobile ! 30: computers. For devices without a keyboard, it offers a a text input ! 31: dialog and one can configure (from command line) buttons for often used ! 32: strings. ! 33: .SH "HATARIUI / HATARIUI.PY" ! 34: .I hatariui ! 35: is actually a shell script wrapper for the hatariui.py Python script. ! 36: It's used to run the Python script with suitable options for default ! 37: usage and to set up the correct installation directory for the rest ! 38: of the Hatari UI Python scripts and data files. ! 39: .PP ! 40: Options below are actually for hatariui.py script. If you want to ! 41: change options given for it, modify the hatariui shell script or ! 42: make your own based on the installed one. ! 43: .\" following command line helps in updating the options: ! 44: .\" hatariui.py --help|sed -e 's/^\t\+/.TP\n.B /' -e 's/\t\+/\n/g' >> hatariui.1 ! 45: .SH "OPTIONS" ! 46: .TP ! 47: .B -h, --help ! 48: Hatari UI command line help ! 49: .TP ! 50: .B -n, --nomenu ! 51: Omit menubar from the window ! 52: .TP ! 53: .B -e, --embed ! 54: Embed Hatari window (to middle of controls) ! 55: .TP ! 56: .B -f, --fullscreen ! 57: Start in fullscreen ! 58: .TP ! 59: .B -l, --left <controls> ! 60: Add a toolbar at left ! 61: .TP ! 62: .B -r, --right <controls> ! 63: Add a toolbar at right ! 64: .TP ! 65: .B -t, --top <controls> ! 66: Add a toolbar at top ! 67: .TP ! 68: .B -b, --bottom <controls> ! 69: Add a toolbar at bottom ! 70: .TP ! 71: .B -p, --panel <name>,<controls> ! 72: Add a separate window with given name and controls ! 73: .PP ! 74: You can have only one toolbar on each side of the Hatari window. ! 75: Panels are separate windows and you can has as many of them as you wish. ! 76: For each panel you need to add a control with the name of the panel ! 77: (see "MyPanel" in examples). ! 78: .PP ! 79: Following controls can are available for toolbars and panels: ! 80: .TP ! 81: .B | ! 82: Separator between controls ! 83: .TP ! 84: .B > ! 85: Next toolbar in panel windows ! 86: .TP ! 87: .B compatibility ! 88: Hatari compatibility list ! 89: .TP ! 90: .B harddisk ! 91: Hard disk images and directories ! 92: .TP ! 93: .B reset ! 94: Warm or cold reset Hatari ! 95: .TP ! 96: .B sconfig ! 97: Save configuration ! 98: .TP ! 99: .B bugs ! 100: Report a bug ! 101: .TP ! 102: .B display ! 103: Display settings ! 104: .TP ! 105: .B authors ! 106: Hatari authors ! 107: .TP ! 108: .B forward ! 109: Whether to fast forward Hatari (needs fast machine) ! 110: .TP ! 111: .B debug ! 112: Activate Hatari debugger ! 113: .TP ! 114: .B quit ! 115: Quit Hatari UI ! 116: .TP ! 117: .B hatari ! 118: Hatari home page ! 119: .TP ! 120: .B recanim ! 121: Record animation ! 122: .TP ! 123: .B recsound ! 124: Record YM/Wav ! 125: .TP ! 126: .B mails ! 127: Hatari mailing lists ! 128: .TP ! 129: .B floppy ! 130: Floppy images ! 131: .TP ! 132: .B device ! 133: Toggle Midi, Printer, RS232 peripherals ! 134: .TP ! 135: .B load ! 136: Load emulation snapshot ! 137: .TP ! 138: .B lconfig ! 139: Load configuration ! 140: .TP ! 141: .B path ! 142: Device & save file paths ! 143: .TP ! 144: .B machine ! 145: Hatari st/e/tt/falcon configuration ! 146: .TP ! 147: .B todo ! 148: Hatari TODO ! 149: .TP ! 150: .B hatariui ! 151: Hatari UI home page ! 152: .TP ! 153: .B save ! 154: Save emulation snapshot ! 155: .TP ! 156: .B joystick ! 157: Joystick settings ! 158: .TP ! 159: .B trace ! 160: Hatari tracing setup ! 161: .TP ! 162: .B pause ! 163: Pause Hatari to save battery ! 164: .TP ! 165: .B about ! 166: Hatari UI information ! 167: .TP ! 168: .B release ! 169: Hatari release notes ! 170: .TP ! 171: .B full ! 172: Toggle whether Hatari is fullscreen ! 173: .TP ! 174: .B manual ! 175: Hatari manual ! 176: .TP ! 177: .B input ! 178: Simulate text input and mouse clicks ! 179: .TP ! 180: .B sound ! 181: Sound settings ! 182: .TP ! 183: .B changes ! 184: Latest Hatari changes ! 185: .TP ! 186: .B run ! 187: (Re-)run Hatari ! 188: .TP ! 189: .B shot ! 190: Grab a screenshot ! 191: .TP ! 192: .B <panel name> ! 193: Button for the specified panel window ! 194: .TP ! 195: .B <name>=<string/code> ! 196: Synthetize string or single key <code> ! 197: .PP ! 198: If no options are given, the UI uses basic controls. ! 199: .SH "EXAMPLES" ! 200: Example on how to add top, right and bottom toolbars and a separate ! 201: "MyPanel" panel window: ! 202: .nf ! 203: hatariui.py --embed \\ ! 204: -t "about,run,pause,quit" \\ ! 205: -p "MyPanel,Macro=Test,Undo=97,Help=98,>,F1=59,F2=60,>,close" \\ ! 206: -r "paste,debug,trace,machine,MyPanel" \\ ! 207: -b "sound,|,fastforward,|,fullscreen" ! 208: .fi ! 209: .PP ! 210: For more examples on Hatari UI options usage, see the hatariui shell ! 211: script. ! 212: .SH "SEE ALSO" ! 213: .IR hatari ! 214: .SH "COPYRIGHT" ! 215: Hatari UI is written by Eero Tamminen <[email protected]>. ! 216: .PP ! 217: This program is free software; you can redistribute it and/or modify ! 218: it under the terms of the GNU General Public License as published by ! 219: the Free Software Foundation; either version 2 of the License, or (at ! 220: your option) any later version. ! 221: .PP ! 222: This program is distributed in the hope that it will be useful, but ! 223: WITHOUT ANY WARRANTY; without even the implied warranty of ! 224: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ! 225: 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.