File: flin.1

package info (click to toggle)
flin 0.5.1-9.2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 276 kB
  • ctags: 164
  • sloc: ansic: 1,642; makefile: 105; sh: 71
file content (210 lines) | stat: -rw-r--r-- 4,819 bytes parent folder | download | duplicates (4)
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
207
208
209
210
.\" -*- nroff -*-
.\" Copyright 1995 Brian Cully (shmit@kublai.com).
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public
.\" License along with this manual; if not, write to the Free
.\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
.\" USA.
.\"
.TH FLIN 1 "13-Jul-95"
.SH NAME
flin \- \fBF\fPlin's a \fBL\fPearners \fBI\fPnterface to '\fBN\fPix \fBS\fPystems.

.SH SYNOPSIS
.B flin [\-hV] [\-d delimiter] [\-e escape] [\-c comment] [menu file]

.SH DESCRIPTION
\fBflin\fP loads \fImenu file\fP and displays it. The menu is made up of any combination of
\fItoken structures\fP seperated by line breaks.

.SH OPTIONS
.TP
.I "\-h"
Print a help message and usage information.
.TP
.I "-V"
Print version information and compile\-time defaults.
.TP
.I "-d delimiter"
Set the delimiter character to \fIdelimiter\fP.
.TP
.I "-e escape"
Set the escape character to \fIescape\fP.
.TP
.I "-c comment"
Set the comment character to \fIcomment\fP.
.TP
.I "menu file"
Load menu from \fImenu file\fP.

.SH FILE FORMAT
\fINote: I will be using `:' as the token delimiter,
`\\' as the escape character, and `#' as the
comment character throughout this document.\fP

Flin files are made up of a series of \fItoken structures\fP and \fIdirectives\fP. There is a
limit of one token structure or directive per line.

Lines beginning with `#' will be ignored by \fBflin\fP.
.br
Characters preceded by `\\' will be treated literally by \fBflin\fP.

.SH Directives
Directives tell \fBflin\fP how to interperet text. Currently \fBflin\fP only understands the
\fIMenu\fP directive. Directives may not be nested.
.TP
.I "Menu name"
Starts a menu named \fIname\fP, all following lines will be interpereted as \fItoken structures\fP
until \fIEndMenu\fP is read.

.SH Token Structures
.PP
Token structures are enclosed within a \fIMenu directive\fP, with one structure per line.
A token structure is made up of at least two fields separated by delimiters. The last field
\fBmust\fP end with a delimiter.
The format of the token structure is:

.RS
.LP
Token:Name:Args:
.RE

Where \fIToken\fP is the type of item to display, \fIName\fP is the name of the item, and
\fIArgs\fP is the argument field. Not all tokens require the argument field, see the \fBTokens\fP
section for details.

.B Tokens
.RS
.TP
.I "Title"
Title inserts a non-selectable title line in the menu.
.RS
.RS
Title:Name:
.RE
.RE

.TP
.I "Nop"
Nop inserts a non-selectable line in the menu, when blank will display a line.
.RS
.RS
Nop:Name:
.br
or
.br
Nop::
.RE
.RE

.TP
.I "SubMenu"
SubMenu creates a link to another menu named in the \fIArgs\fP field.
.RS
.RS
SubMenu:Name:Args:
.RE
.RE

.TP
.I "Exec"
Exec executes the \fIArgs\fP field.
.RS
.RS
Exec:Name:Args:
.RE
.RE

.TP
.I "Args"
Args executes the \fIArgs\fP field with user inputted command-line arguments.
The optional \fIPrompt\fP field contains the prompt for the dialog box.
\fIUse with care!\fP If you use this improperly, you could open up a big security whole on your
system.
.RS
.RS
Args:Name:Args:\fIPrompt:\fP
.RE
.RE

.TP
.I "Exit"
Exit exits the current menu, returning to the previous menu. If Exit is executed in the first menu
loaded Flin will quit.
.RS
.RS
Exit:Name:
.RE
.RE

.TP
.I "Quit"
Exits flin.
.RS
.RS
Quit:Name:
.RE
.RE
.RE

.SH EXAMPLE MENU
Here is an example menu (comment character is `#', delimiter is `:'):

.RS
.nf
#
#	test.menu - A sample menu for `flin'
#		    to try it out type:
#		    flin test.menu
#

# Startup Menu
Menu Main
    Title:Main Menu:
    Nop::
    SubMenu:File Utitities:File-Util:
    SubMenu:Surf the 'Net:InterNet:
    Exit:Logout:
EndMenu

# File utilities
Menu File-Util
    Title:File Menu:
    Nop::
    Exec:Directory listing:ls -F:
    Exit:Back to Main Menu:
EndMenu

# Net `Surfing'
Menu InterNet
    Title:Internet:
    Nop::
    Exec:CyberMail:pine:
    Nop:Anything's cooler if you prepend it with `cyber':
    Exec:Telnet:telnet:
    Exec:Ftp:ftp:
    Exit:Back to Main Menu:
EndMenu
.fi
.RP

.SH BUGS
No! No! Never! Yes. A bit. She has got a wart.

.SH AUTHOR
Brian Cully (shmit@kublai.com)