--- hatari/python-ui/hatariui.1 2019/04/09 08:48:23 1.1 +++ hatari/python-ui/hatariui.1 2019/04/09 08:58:36 1.1.1.5 @@ -2,27 +2,27 @@ .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) -.TH "hatariui" "1" "2010-05-30" "Hatari" "Hatari UI" +.TH "hatariui" "1" "2019-01-09" "Hatari" "Hatari UI" .SH "NAME" hatariui \- Python/Gtk UI for Hatari .SH "SYNOPSIS" .B hatariui | hatariui.py .RI [options] -.RI [diskimage] +.RI [directory|diskimage|program] .SH "DESCRIPTION" .I hatariui is a Python/Gtk UI for Hatari which can either embed the Hatari window (on X11 systems) or run in a separate window. By default it provides a normal application menu and some extra button for faster access to -fast-forward etc. functionality, but these are fully configurable +fast\-forward etc. functionality, but these are fully configurable with the command line options. While it lacks support for some of the Hatari configuration options that Hatari's SDL GUI has, it also -supports some options that the Hatari's built-in SDL UI doesn't. +supports some options that the Hatari's built\-in SDL UI doesn't. .PP -Besides the UI configurability, some of the other advantages it has +Besides the UI configurability, some of the other advantages hatariui has over the SDL interface included with Hatari itself are use of a normal Gtk file selector with all of its features (directory shortcuts etc), -support for UTF-8 (in file names) and in general blending better to +support for UTF\-8 (in file names) and in general blending better to the user's desktop environment. .PP Additionally, Hatari can run while one uses UI configuration dialogs, @@ -32,63 +32,63 @@ dialog and one can configure (from comma strings. .SH "HATARIUI / HATARIUI.PY" .I hatariui -is actually a shell script wrapper for the hatariui.py Python script. +is a shell script wrapper for the hatariui.py Python script. It's used to run the Python script with suitable options for default -usage and to set up the correct installation directory for the rest +usage, and to set up the correct installation directory for rest of the Hatari UI Python scripts and data files. .PP -Options below are actually for hatariui.py script. If you want to -change options given for it, modify the hatariui shell script or +Options below are actually for the hatariui.py script. If you want +to change options given for it, modify the hatariui shell script or make your own based on the installed one. .\" following command line helps in updating the options: -.\" hatariui.py --help|sed -e 's/^\t\+/.TP\n.B /' -e 's/\t\+/\n/g' >> hatariui.1 +.\" hatariui.py --help|sed -e 's/^\t\+/.TP\n.B /' -e 's/\t\+/\n/g' -e 's/-/\\-/g' >> hatariui.1 .SH "OPTIONS" .TP -.B -h, --help +.B \-h, \-\-help Hatari UI command line help .TP -.B -n, --nomenu +.B \-n, \-\-nomenu Omit menubar from the window .TP -.B -e, --embed +.B \-e, \-\-embed Embed Hatari window (to middle of controls) .TP -.B -f, --fullscreen +.B \-f, \-\-fullscreen Start in fullscreen .TP -.B -l, --left +.B \-l, \-\-left Add a toolbar at left .TP -.B -r, --right +.B \-r, \-\-right Add a toolbar at right .TP -.B -t, --top +.B \-t, \-\-top Add a toolbar at top .TP -.B -b, --bottom +.B \-b, \-\-bottom Add a toolbar at bottom .TP -.B -p, --panel , +.B \-p, \-\-panel , Add a separate window with given name and controls .PP You can have only one toolbar on each side of the Hatari window. -Panels are separate windows and you can has as many of them as you wish. -For each panel you need to add a control with the name of the panel -(see "MyPanel" in examples). +Panels are separate windows and you can have as many of them as you wish. +For each of the panels, you need to add a button with the name of +the panel (see "MyPanel" in the Examples section). .PP -Following controls can are available for toolbars and panels: +Following buttons can be added to toolbars and panels: .TP .B | -Separator between controls +Separator between action buttons .TP .B > -Next toolbar in panel windows +Start next toolbar row in panel windows .TP .B compatibility Hatari compatibility list .TP .B harddisk -Hard disk images and directories +Hard disk config dialog .TP .B reset Warm or cold reset Hatari @@ -100,13 +100,13 @@ Save configuration Report a bug .TP .B display -Display settings +Display settings dialog .TP .B authors Hatari authors .TP .B forward -Whether to fast forward Hatari (needs fast machine) +Toggle Hatari fast-forward .TP .B debug Activate Hatari debugger @@ -127,10 +127,10 @@ Record YM/Wav Hatari mailing lists .TP .B floppy -Floppy images +Floppy image dialog .TP .B device -Toggle Midi, Printer, RS232 peripherals +Midi / Printer / RS232 enabling dialog .TP .B load Load emulation snapshot @@ -139,10 +139,10 @@ Load emulation snapshot Load configuration .TP .B path -Device & save file paths +Path config dialog .TP .B machine -Hatari st/e/tt/falcon configuration +Hatari machine config dialog .TP .B todo Hatari TODO @@ -154,10 +154,10 @@ Hatari UI home page Save emulation snapshot .TP .B joystick -Joystick settings +Joystick settings dialog .TP .B trace -Hatari tracing setup +Hatari tracing dialog .TP .B pause Pause Hatari to save battery @@ -175,16 +175,16 @@ Toggle whether Hatari is fullscreen Hatari manual .TP .B input -Simulate text input and mouse clicks +Text / mouse click injection dialog .TP .B sound -Sound settings +Sound settings dialog .TP .B changes Latest Hatari changes .TP .B run -(Re-)run Hatari +(Re\-)run Hatari .TP .B shot Grab a screenshot @@ -193,26 +193,29 @@ Grab a screenshot Button for the specified panel window .TP .B = -Synthetize string or single key +Synthetize string or single key . NOTE: disable fast-forward +before injection or key-repeat will repeat each injected key! .PP If no options are given, the UI uses basic controls. .SH "EXAMPLES" Example on how to add top, right and bottom toolbars and a separate "MyPanel" panel window: .nf - hatariui.py --embed \\ - -t "about,run,pause,quit" \\ - -p "MyPanel,Macro=Test,Undo=97,Help=98,>,F1=59,F2=60,>,close" \\ - -r "paste,debug,trace,machine,MyPanel" \\ - -b "sound,|,fastforward,|,fullscreen" + hatariui.py \-\-embed \\ + \-t "about,run,pause,quit" \\ + \-p "MyPanel,Macro=Test,Undo=97,Help=98,>,F1=59,F2=60,>,close" \\ + \-r "pause,debug,trace,machine,MyPanel" \\ + \-b "sound,|,forward,|,full" .fi .PP For more examples on Hatari UI options usage, see the hatariui shell script. .SH "SEE ALSO" -.IR hatari +.IR hmsa (1), +.IR hatariui (1), +.IR hconsole (1) .SH "COPYRIGHT" -Hatari UI is written by Eero Tamminen . +Hatari UI is written by Eero Tamminen . .PP 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