NAME

tarotplane - Curses flashcard program

SYNOPSIS

tarotplane [options] file ...

DESCRIPTION

tarotplane is a TUI flashcard program written in Perl using the Curses module. It reads cards from specially formatted text files consisting of terms and definitions, then displays them in a TUI.

Card Files

A tarotplane card file consists of lines that contain terms and their respective definitions seperated by a colon (:). Text preceding the colon is considered the term, text following the colon is considered the term's definition.

Lines starting with a hash (#) are treated as comments and are ignored. Blank lines are also ignored.

Escape Sequences

An escape sequence is a pair of characters, a forward slash (\) and some other character, that signals to tarotplane to perform special behavior when reading/displaying the card. Below is a list of all the escape sequences tarotplane supports:

\\

Single back slash (\).

\:

Colon (:).

\n

Force linebreak.

Controls

The controls for tarotplane can be viewed during runtime by entering '?'.

Right Arrow, l

Next card.

Left Arrow, h

Previous card.

Space, Up/Down Arrow, j/k

Flip to other side.

Page Down, End

Go to last card.

Page Up, Home

Go to first card.

q

Quit.

?

Help screen for controls.

OPTIONS

-o [by], --order[=by]

Order cards to appear alphabetically. by can either be 'Term' or 'Definition' (case-insensitive) to specify which sides to compare when ordering. If by is not specified, defaults to sorting by terms.

-r, --random

Randomizes the order the cards appear in.

-t, --terms-first

Show terms first rather than definitions.

-h, --help

Print help message and exit.

-v, --version

Print version and copyright information, then exit.

EXAMPLES

An example of a valid card file:

# Comment
# Term: Definition
$: Dollar sign
^: Caret
!: Exclamation point

# Note the backslashes
\:): Smiley face
>\:): Angry face

AUTHOR

Written by Samuel Young <samyoung12788@gmail.com>.

COPYRIGHT

Copyright 2024, Samuel Young.

This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself.