libx48ng/dist/x48ng.man.1

.\" # @configure_input@
.\"
.\" $Id$
.\" Copyright (c) 2005  G. Allen Morris III
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining
.\" a copy of this software and associated documentation files (the
.\" "Software"), to deal in the Software without restriction, including
.\" without limitation the rights to use, copy, modify, merge, publish,
.\" distribute, sublicense, and/or sell copies of the Software, and to
.\" permit persons to whom the Software is furnished to do so, subject to
.\" the following conditions:
.\"
.\" The above copyright notice and this permission notice shall be included
.\" in all copies or substantial portions of the Software.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
.\" OTHER DEALINGS IN THE SOFTWARE.
.\"
.\" Except as contained in this notice, the name of the X Consortium shall
.\" not be used in advertising or otherwise to promote the sale, use or
.\" other dealings in this Software without prior written authorization
.\" from the X Consortium.
.\"
.\" $XFree86: xc/programs/xcalc/xcalc.man,v 1.5 2003/03/19 01:49:28 dawes Exp $
.\"
.de EX  \"Begin example
.ne 5
.if n .sp 1
.if t .sp .5
.nf
.in +.5i
..
.de EE
.fi
.in -.5i
.if n .sp 1
.if t .sp .5
..
.TH X48NG 1 "14 September 2023" "Version @VERSION@" "X48NG Manual Pages"
.SH NAME
x48ng \- scientific calculator and an HP 48 emulator
.SH SYNOPSIS
.B x48ng
[\--options ...]

where options include (depending on compiled front-ends):
.br
        \-h \-\-help                    what you are reading
.br
        \-v \-\-version                 show version
.br
            \-\-print\-config           print configuration as config file
.br
        \-c <path> \-\-config=<path>    use <path> as x48ng's config file (default: ~/.config/x48ng/config.lua)
.br
           \-\-config\-dir=<path>       use <path> as x48ng's home (default: ~/.config/x48ng/)
.br
           \-\-rom=<filename>          use <filename> (absolute or relative to <config\-dir>) as ROM (default: rom)
.br
           \-\-ram=<filename>          use <filename> (absolute or relative to <config\-dir>) as RAM (default: ram)
.br
           \-\-state=<filename>        use <filename> (absolute or relative to <config\-dir>) as STATE (default: hp48)
.br
           \-\-port1=<filename>        use <filename> (absolute or relative to <config\-dir>) as PORT1 (default: port1)
.br
           \-\-port2=<filename>        use <filename> (absolute or relative to <config\-dir>) as PORT2 (default: port2)
.br
           \-\-serial\-line=<path>      use <path> as serial device default: /dev/ttyS0)
.br
        \-V \-\-verbose                 be verbose (default: false)
.br
           \-\-x11                     use X11 front-end (default: true)
.br
           \-\-sdl2                    use SDL2 front-end (default: false)
.br
           \-\-sdl                     use SDL front-end (DEPRECATED) (default: false)
.br
           \-\-tui                     use terminal front-end (default: false)
.br
           \-\-tui\-small               use text small front-end (2×2 pixels per character) (default: false)
.br
           \-\-tui\-tiny                use text tiny front-end (2×2 pixels per character) (default: false)
.br
        \-t \-\-terminal            activate pseudo terminal interface (default: false)
.br
        \-s \-\-serial              activate serial interface (default: false)
.br
           \-\-debug                enable the debugger
.br
        \-r \-\-reset                   perform a reset on startup
.br
        \-T \-\-throttle                try to emulate real speed (default: false)
.br
           \-\-no\-chrome           only display the LCD (default: false)
.br
           \-\-fullscreen          make the UI fullscreen (default: false)
.br
           \-\-scale=<float>   scale the SDL2 UI by <float>
.br
           \-\-netbook             make the UI horizontal (default: false)
.br
           \-\-visual=<X visual>   use visual <X visual> (default: default), possible values: <default | staticgray | staticcolor | truecolor | grayscale | pseudocolor | directcolor | 0xnn | nn>
.br
           \-\-small\-font=<fontname>  use <fontname> as small font
.br
           \-\-medium\-font=<fontname> use <fontname> as medium font
.br
           \-\-large\-font=<fontname>  use <fontname> as large font
.br
           \-\-connection\-font=<fontname> use <fontname> as connection font
.br
           \-\-mono                make the UI monochrome (default: false)
.br
           \-\-gray                make the UI grayscale (default: false)
.br
           \-\-leave\-shift\-keys    _not_ mapping the shift keys to let them free for numbers (default: false)
.br
           \-\-inhibit\-shutdown    __tentative fix for stuck-on-OFF bug__ (default: false)


.SH DESCRIPTION
.I x48ng
is a scientific calculator desktop accessory that emulate an HP\-48 SX
or an HP\-48 GX.
\" .SH OPTIONS
\" .PP
\" \fIx48ng\fP accepts all of the standard toolkit command line options along
\" with several additional options:
\" .PP
\" .TP 8
\" .B \-help
\" Show a list of options.
\" .PP
\" .TP 8
\" .B \-version
\" This  causes  x48ng  to  print a version number to the standard output.
\" .PP
\" .TP 8
\" .B \-iconic
\" Start iconic
\" .SH OPERATION

.PP
x48ng emulates an HP 48 calculator. This manual does not attempt to
describe the operation of the HP calulator, but only the user interface
to the emulator.

\" .I Pointer Usage:
\" When mouse button one is press on an x48ng key the key is depress until
\" the mouse button is released.  If you wish to have more than one key
\" press at a time mouse button 3 may be used.  Button pressed with mouse
\" button 3 will remain pressed until mouse button 1 is used.  For example
\" to reset the calulator you can press the A key and the F key with mouse
\" button 3 and then press the on button with mouse button 1.

\" Mouse button 2 will paste the text in the cut buffer to the calculator
\" if it is press in the display area of the calculator. See notes on
\" pasting text into the calculator below.

\" Use of mouse elsewhere on the image of the calculator is undefined.

.SH ACCELERATORS

The keyboard may be used to input data into the x48ng.
The number keys on the keyboard coresponds to the number buttons on
the calaculator, and the alphbetic keys on the keyboard control the
buttons on the top half of the calculator and the @code{+/-} and
@code{EXX} keys.

The @code{ENTER} button is attached to the Enter key, the delete key
to the <-/DROP button and Divide, multiply, subtract and add buttons to
the /, *, -, and + keys on the key board.

.SH --tui SPECIAL KEYBINDINGS

I had to be a bit 'creative' mapping keys there:

- [On] is either [F4] or [Esc] or [Home] or [\\]

- [Left Shift] is either [F5] or [PgUp] or [[]

- [Right Shift] is either [F6] or [PgDn] or []]

- [Alpha] is either [F8] or [Ins] or [;]

To quit `x48ng --tui` use [F10] or [Shift+End] or [|]


.SH COLORS
The x48ng is trying to look like a particular device.
The colors are therefore not selectable.
.br
\" .SH "ENVIRONMENT"
\" XUSERFILESEARCHPATH
\" .SH "SEE ALSO"
\" X(7x), xrdb(1)
.SH BUGS
.PP
Bugs can be found and reported at: https://github.com/gwenhael-le-moine/x48ng
.SH COPYRIGHT
Copyright \(co 2023- Gwenhael Le Moine
.br
Copyright \(co 1994-2005 Eddie C. Dost
.br
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.SH AUTHORS
Gwenhael Le Moine
.br
Eddie C. Dost
.br
G. Allen Morris III <gam3@gam3.net>