c8emul.1

   1 .\" SPDX-License-Identifier: BSD-2-Clause
   2
   3 .\" Copyright (c) 2021 Alessio Chiapperini
   4
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25
  26 .Dd November 16, 2021
  27 .Dt C8EMUL 1
  28 .Os
  29 .Sh NAME
  30 .Nm c8emul
  31 .Nd CHIP-8 emulator
  32 .Sh SYNOPSIS
  33 .Nm
  34 .Op Fl s Ar scaling_factor
  35 .Op Fl d Ar cycle_delay
  36 .Op Ar rom_file
  37 .Sh DESCRIPTION
  38 .Nm
  39 is a CHIP-8 emulator implemented in C99 using the SDL2 multimedia library.
  40 If the
  41 .Ar rom_file
  42 is absent,
  43 .Nm
  44 reads from standard input. The predefined window size is 64x32, but it can be scaled up using the
  45 .Ar scaling_factor
  46 flag. Moreover, since the CHIP-8 has no specified clock speed and different games run at different
  47 speeds, the delay in milliseconds between cycles can be specified via the
  48 .Ar cycle_delay
  49 flag which defaults to 3ms if not specified otherwise.
  50 .Pp
  51 The options are as follows:
  52 .Bl -tag -width indent
  53 .It Fl s Ar scaling_factor
  54 Use
  55 .Ar scaling_factor
  56 as a multiplier for the predefined window size of 64x32.
  57 .It Fl d Ar cycle_delay
  58 Use
  59 .Ar cycle_delay
  60 as time in milliseconds between cycles.
  61 .El
  62 .Sh "EXIT STATUS"
  63 The
  64 .Nm
  65 utility exits 0 on success, and 1 if an error occurs.
  66 .Sh EXAMPLES
  67 Load ROM from stdin and display it in 640x320 with the default 3ms cycle delay:
  68 .Dl "c8emul -s 10"
  69 .Pp
  70 Load ROM from file and scale the window to 640x320 with a 2ms cycle delay:
  71 .Pp
  72 .Dl "c8emul -s 10 -d 2 Chip8_Picture.ch8"
  73 .Sh BUGS
  74 .Bl -tag -width indent
  75 .It Audio is not supported.
  76 .El
  77 .Sh AUTHOR
  78 .An Alessio Chiapperini Aq Mt alessio.chiapperini@\:nullbuffer.com