diff options
Diffstat (limited to 'games/noteye/noteye.pod')
-rw-r--r-- | games/noteye/noteye.pod | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/games/noteye/noteye.pod b/games/noteye/noteye.pod new file mode 100644 index 0000000000..e4e929fa5c --- /dev/null +++ b/games/noteye/noteye.pod @@ -0,0 +1,88 @@ +# pod source for noteye man page. convert with: +# pod2man --stderr -s6 -cSlackBuilds.org -r7.6 noteye.pod > noteye.6 + +=head1 NAME + +noteye - graphical front-end for rogue-like games + +=head1 SYNOPSIS + +B<noteye> I<[-options]> + +=head1 DESCRIPTION + +Necklace of the Eye (NotEye in short) is a roguelike frontend. It can +modify the output of console and libtcod roguelikes, and it also works +as a library which allows to easily port old ASCII roguelikes like ADOM +into 21st century. NotEye is a complicated piece of software, and it is +constantly in development, and not documented very well. + +This man page is incomplete and possibly inaccurate, but is perhaps +better than having no documentation at all. + +=head1 OPTIONS + +=over 4 + +=item B<-N> + +Arguments are ignored (or passed to the game being run) until B<-N> +is seen. The options below only have effect if B<-N> is given first. + +=item B<-N0> + +Cancel the effect of a previously-given B<-N> option: options after this +are either ignored or passed to the game being run. + +=item B<--ascii> + +Run in a terminal with a curses-like interface, rather than an X11 GUI window. + +=item B<-C> I<config-file> + +Use I<config-file> as the config. + +=item B<-C1> I<config-file-format> + +Use I<config-file-format> as the config, replacing any occurrence of GAMENAME +with the name of the game being run (set via the B<-X> option). + +=item B<-tcod> + +Automatically connect to TCOD server. The server hostname/IP and port +number must be defined in the config (probably by entering them in the +noteye networking menu). + +=item B<-server> + +Automatically connect to noteye server. As with B<-tcod>, the server must +already be defined. + +=item B<-L> I<logfile> + +Write game log to I<logfile>. + +=item B<-X> I<game> + +Launch this game, instead of displaying the main noteye menu. + +=back + +=head1 FILES + +B<~/.config/noteye/config.noe> is the main config file. Editable, but +normally updated using noteye's built-in menus instead of a text editor. + +=head1 SEE ALSO + +B<hydraslayer>(6), +B<rogue>(6) + +The noteye homepage: http://www.roguetemple.com/z/noteye.php + +=head1 AUTHORS + +hydraslayer and noteye are written by Zeno Rogue <zeno at attnam dot com>. + +This man page written by B. Watson for the SlackBuilds.org project, and may be used +by anyone. |