File: gopherweblink.1

package info (click to toggle)
gopherweblink 1.04
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 132 kB
  • ctags: 1
  • sloc: sh: 143; makefile: 44
file content (77 lines) | stat: -rw-r--r-- 2,883 bytes parent folder | download | duplicates (2)
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
.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH GOPHERWEBLINK 1 "December 20, 2000"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
gopherweblink \- program to generate web link files for gopher
.SH SYNOPSIS
.B gopherweblink
.RI [ RECURSE=yes ] " files" ...
.SH DESCRIPTION
.br
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
.\" respectively.
\fBgopherweblink\fP is a program that will generate HTML files from
specification files, such that it is possible to greate a link to
a web server from a gopher document tree.  Since the gopher directory
specification does not support URLs, a workaround is required.  One
way to put URL references into the gopher directory is to place
HTML files in the gopher tree that use the META REFRESH to load the
real destination (gopher can serve up HTML).  This can be a pain, so
\fBgopherweblink\fP is here to help automate the generation of these files.

.br
To use \fBgopherweblink\fP, you will first create .gwlnk files in any
directory you linke on the gopher server.  Then, you'll run
\fBgopherweblink\fP to process these .gwlnk files and generate .html
files.  Finally, you will add entries to your .Links files in relevant
directories to refer to these .html files, in the gopher tree,
as the target of the link.

.br
The .gwlnk files have a simple format.  Each file has exactly one
line, which looks like this:
.br

m4_define(`DESTURL', `http://www.complete.org')
.br

When you run \fBgopherweblink\fP, it will process each .gwlnk file
and generate an appropriate .html file with the link.
.br

Also, \fBgopherweblink\fP can create .infolinks files from .info files.
Create a .info file and this program will create a .infolinks file
of a format suitable for parsing by UMN Gopherd to display as greeting
text for a specific directory.
.br

.SH OPTIONS
This program has only one option.  You can specify options in the
usual \fBmake\fP(1) manner as well.
.TP
.B RECURSE=yes
Tells \fBgopherweblink\fP to process all .gwlnk files in all
subdirectories of the current directory, instead of only the .gwlnk
files in the current directory.
.SH SEE ALSO
.BR make (1),
.BR gopherd (8).
.br
.SH AUTHOR
This manual page was written by John Goerzen <jgoerzen@complete.org>.