aboutsummaryrefslogtreecommitdiff
path: root/games/noteye/noteye.6
blob: 12c53ee0f7c633ead74d3fac02b9db29ea069f00 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "NOTEYE 6"
.TH NOTEYE 6 "2014-09-03" "7.6" "SlackBuilds.org"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
noteye \- graphical front\-end for rogue\-like games
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBnoteye\fR \fI[\-options]\fR
.SH "DESCRIPTION"
.IX Header "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 \s-1ASCII\s0 roguelikes like \s-1ADOM\s0
into 21st century. NotEye is a complicated piece of software, and it is
constantly in development, and not documented very well.
.PP
This man page is incomplete and possibly inaccurate, but is perhaps
better than having no documentation at all.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-N\fR" 4
.IX Item "-N"
Arguments are ignored (or passed to the game being run) until \fB\-N\fR
is seen. The options below only have effect if \fB\-N\fR is given first.
.IP "\fB\-N0\fR" 4
.IX Item "-N0"
Cancel the effect of a previously-given \fB\-N\fR option: options after this
are either ignored or passed to the game being run.
.IP "\fB\-\-ascii\fR" 4
.IX Item "--ascii"
Run in a terminal with a curses-like interface, rather than an X11 \s-1GUI\s0 window.
.IP "\fB\-C\fR \fIconfig-file\fR" 4
.IX Item "-C config-file"
Use \fIconfig-file\fR as the config.
.IP "\fB\-C1\fR \fIconfig-file-format\fR" 4
.IX Item "-C1 config-file-format"
Use \fIconfig-file-format\fR as the config, replacing any occurrence of \s-1GAMENAME\s0
with the name of the game being run (set via the \fB\-X\fR option).
.IP "\fB\-tcod\fR" 4
.IX Item "-tcod"
Automatically connect to \s-1TCOD\s0 server. The server hostname/IP and port
number must be defined in the config (probably by entering them in the
noteye networking menu).
.IP "\fB\-server\fR" 4
.IX Item "-server"
Automatically connect to noteye server. As with \fB\-tcod\fR, the server must
already be defined.
.IP "\fB\-L\fR \fIlogfile\fR" 4
.IX Item "-L logfile"
Write game log to \fIlogfile\fR.
.IP "\fB\-X\fR \fIgame\fR" 4
.IX Item "-X game"
Launch this game, instead of displaying the main noteye menu.
.SH "FILES"
.IX Header "FILES"
\&\fB~/.config/noteye/config.noe\fR is the main config file. Editable, but
normally updated using noteye's built-in menus instead of a text editor.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBhydraslayer\fR(6),
\&\fBrogue\fR(6)
.PP
The noteye homepage: http://www.roguetemple.com/z/noteye.php
.SH "AUTHORS"
.IX Header "AUTHORS"
hydraslayer and noteye are written by Zeno Rogue <zeno at attnam dot com>.
.PP
This man page written by B. Watson for the SlackBuilds.org project, and may be used
by anyone.