rackety man pages

This commit is contained in:
Matthew Flatt 2010-05-05 09:55:52 -06:00
parent 27cd77c16c
commit d282a49a9d
10 changed files with 310 additions and 194 deletions

89
man/man1/drracket.1 Normal file
View File

@ -0,0 +1,89 @@
.\" dummy line
.TH DRRACKET 1 "May 2010"
.UC 4
.SH NAME
drracket \- the Racket programming environment
.SH SYNOPSIS
.B drracket
[
.I Xoption ...
]
[
.I file ...
]
.SH DESCRIPTION
DrRacket
is the Racket
programming environment.
.PP
The
.B drracket
program treats non-switch command-line arguments as files to open.
.SH X OPTIONS
When running in X11, DrRacket accepts the following standard
.IR Xoption s:
.B -display
.IR disp ,
.B -geometry
.IR geom ,
.B -bg
.IR color ,
.B -background
.IR color ,
.B -fg
.IR color ,
.B -foreground
.IR color ,
.B -fn
.IR font ,
.B -font
.IR font ,
.BR -iconic ,
.B -name
.IR name ,
.BR -rv ,
.BR -reverse ,
.BR +rv ,
.B -selectionTimeout
.IR time ,
.BR -synchronous ,
.B -title
.IR name ,
.B -xnllanguage
.IR lang ,
.B -xrm
.IR file .
.PP
In addition, the option
.B -singleInstance
is treated like an X option (it must appear before all other
options), and it runs DrRacket in single-instance mode.
In single-instance mode, when an existing instance
is running with the same host and executable name, all non-option
arguments are treated as file names and sent to the
existing instance.
.SH MORE INFORMATION
.PP
For further information, run
.PP
raco docs
.PP
to open installed documentation in your web browser.
.PP
Alternately, consult the on-line
documentation and other information available at
.PP
.ce 1
http://www.racket-lang.org/
.SH AUTHOR
.I DrRacket
was implemented by PLT.
.SH SEE ALSO
.BR raco(1),
.BR racket(1),
.BR gracket(1)

View File

@ -1,8 +1,8 @@
.\" dummy line .\" dummy line
.TH DRSCHEME 1 "January 2008" .TH DRSCHEME 1 "May 2010"
.UC 4 .UC 4
.SH NAME .SH NAME
drscheme \- The PLT Scheme programming environment drscheme \- the Racket programming environment
.SH SYNOPSIS .SH SYNOPSIS
.B drscheme .B drscheme
[ [
@ -12,78 +12,13 @@ drscheme \- The PLT Scheme programming environment
.I file ... .I file ...
] ]
.SH DESCRIPTION .SH DESCRIPTION
DrScheme DrScheme is the old name for the Racket programming environment.
is the PLT Scheme
programming environment.
.PP .PP
The Running
.B drscheme .B drscheme
program treats non-switch command-line arguments as files to open. is the same as running
.BR drracket .
.SH X OPTIONS
When running in X11, DrScheme accepts the following standard
.IR Xoption s:
.B -display
.IR disp ,
.B -geometry
.IR geom ,
.B -bg
.IR color ,
.B -background
.IR color ,
.B -fg
.IR color ,
.B -foreground
.IR color ,
.B -fn
.IR font ,
.B -font
.IR font ,
.BR -iconic ,
.B -name
.IR name ,
.BR -rv ,
.BR -reverse ,
.BR +rv ,
.B -selectionTimeout
.IR time ,
.BR -synchronous ,
.B -title
.IR name ,
.B -xnllanguage
.IR lang ,
.B -xrm
.IR file .
.PP
In addition, the option
.B -singleInstance
is treated like an X option (it must appear before all other
options), and it runs MrEd in single-instance mode.
In single-instance mode, when an existing instance
is running with the same host and executable name, all non-option
arguments are treated as file names and sent to the
existing instance.
.SH MORE INFORMATION
.PP
For further information, run
.PP
plt-help
.PP
to open installed documentation in your web browser.
.PP
Alternately, consult the on-line
documentation and other information available at
.PP
.ce 1
http://www.drscheme.org/
.SH AUTHOR
.I DrScheme
was implemented by PLT, http://www.plt-scheme.org/.
.SH SEE ALSO .SH SEE ALSO
.BR plt-help(1), .BR drracket(1)
.BR mzscheme(1),
.BR mred(1)

61
man/man1/gracket.1 Normal file
View File

@ -0,0 +1,61 @@
\" dummy line
.TH GRACKET 1 "May 2010"
.UC 4
.SH NAME
gracket \- the GUI Racket implementation
.SH SYNOPSIS
.B gracket
[
.I option ...
] [
.I argument ...
]
.SH DESCRIPTION
GRacket is the GUI-application variant of
.BR racket .
.PP
Run
.PP
gracket --help
.PP
for a list of command-line options and other start-up information.
.PP
Supplying no arguments to
.B gracket
is the same as supplying the
.B -i
option for interactive evaluation.
.PP
Supplying a single non-switch argument to
.B gracket
is the same as putting
.B -u
before the argument to run it as a module-based script.
.SH MORE INFORMATION
For further information, run
.PP
raco docs
.PP
to open installed documentation in your web browser.
.PP
Alternately, consult the on-line
documentation and other information available at
.PP
.ce 1
http://www.racket-lang.org/
.SH AUTHOR
GRacket was implemented by Matthew Flatt (mflatt@racket-lang.org),
Robert Bruce Findler (robby@racket-lang.org),
John Clements (clements@racket-lang.org), and PLT.
.SH SEE ALSO
.BR raco(1),
.BR drracket(1),
.BR racket(1)

View File

@ -1,8 +1,8 @@
\" dummy line .\" dummy line
.TH MRED 1 "January 2008" .TH MRED 1 "May 2010"
.UC 4 .UC 4
.SH NAME .SH NAME
mred \- The PLT Graphical Scheme implementation mred \- compatibility executable for Racket
.SH SYNOPSIS .SH SYNOPSIS
.B mred .B mred
[ [
@ -10,40 +10,21 @@ mred \- The PLT Graphical Scheme implementation
] [ ] [
.I argument ... .I argument ...
] ]
.SH DESCRIPTION .SH DESCRIPTION
MrEd MrEd is the old name for the GUI Racket implementation.
is the PLT graphical Scheme
implementation.
It embeds and extends
MzScheme
with a graphical user interface (GUI) toolbox.
.PP .PP
Run For most cases, running
.PP
mred --help
.PP
for a list of command-line options and other start-up information.
.PP
Supplying no arguments to
.B mred .B mred
is the same as supplying the is the same as running
.B -i .BR gracket ,
option for interactive evaluation. except that the default interaction language is slightly
different for backward compatibility.
.PP
Supplying a single non-switch argument to
.B mred
is the same as putting
.B -u
before the argument to run it as a module-based script.
.SH MORE INFORMATION .SH MORE INFORMATION
For further information, run For further information, run
.PP .PP
plt-help raco docs
.PP .PP
to open installed documentation in your web browser. to open installed documentation in your web browser.
@ -52,15 +33,7 @@ Alternately, consult the on-line
documentation and other information available at documentation and other information available at
.PP .PP
.ce 1 .ce 1
http://www.plt-scheme.org/software/mred/ http://www.racket-lang.org/
.SH AUTHOR
MrEd was implemented by Matthew Flatt (mflatt@plt-scheme.org),
Robert Bruce Findler (robby@plt-scheme.org), and
John Clements (clements@plt-scheme.org), based on
MzScheme.
.SH SEE ALSO .SH SEE ALSO
.BR plt-help(1), .BR gracket(1)
.BR drscheme(1),
.BR mzscheme(1)

View File

@ -1,8 +1,8 @@
.\" dummy line .\" dummy line
.TH MZC 1 "January 2008" .TH MZC 1 "May 2010"
.UC 4 .UC 4
.SH NAME .SH NAME
mzc \- The PLT Scheme compiler tool mzc \- compatibility Racket compiler tool
.SH SYNOPSIS .SH SYNOPSIS
.B mzc .B mzc
[ [
@ -12,8 +12,9 @@ mzc \- The PLT Scheme compiler tool
] ]
.SH DESCRIPTION .SH DESCRIPTION
.B mzc .B mzc
performs various tasks such as compiling Scheme source to bytecode, provides an old interface to some Racket tools that are now
packaging executables, and packaging installable archives. normally provided via
.BR raco .
.PP .PP
Run Run
@ -25,7 +26,7 @@ for a list of command-line options.
.SH MORE INFORMATION .SH MORE INFORMATION
For further information, run For further information, run
.PP .PP
plt-help raco docs
.PP .PP
to open installed documentation in your web browser. to open installed documentation in your web browser.
@ -34,12 +35,8 @@ Alternately, consult the on-line
documentation and other information available at documentation and other information available at
.PP .PP
.ce 1 .ce 1
http://www.plt-scheme.org/software/mzc/ http://www.racket-lang.org/
.SH AUTHOR
.B mzc
was implemented by PLT, http://www.plt-scheme.org/.
.SH SEE ALSO .SH SEE ALSO
.BR plt-help(1), .BR raco(1),
.BR mzscheme(1), .BR racket(1)
.BR drscheme(1)

View File

@ -1,8 +1,8 @@
.\" dummy line .\" dummy line
.TH MZSCHEME 1 "January 2008" .TH MZSCHEME 1 "May 2010"
.UC 4 .UC 4
.SH NAME .SH NAME
mzscheme \- The PLT Scheme implementation mzscheme \- compatibility executable for Racket
.SH SYNOPSIS .SH SYNOPSIS
.B mzscheme .B mzscheme
[ [
@ -11,35 +11,20 @@ mzscheme \- The PLT Scheme implementation
.I argument ... .I argument ...
] ]
.SH DESCRIPTION .SH DESCRIPTION
MzScheme MzScheme is the old name for the core Racket implementation.
is the PLT
Scheme implementation.
.PP .PP
Run For most cases, running
.PP
mzscheme --help
.PP
for a list of command-line options and other start-up information.
.PP
Supplying no arguments to
.B mzscheme .B mzscheme
is the same as supplying the is the same as running
.B -i .BR racket ,
option for interactive evaluation. except that the default interaction language is slightly
different for backward compatibility.
.PP
Supplying a single non-switch argument to
.B mzscheme
is the same as putting
.B -u
before the argument to run it as a module-based script.
.SH MORE INFORMATION .SH MORE INFORMATION
For further information, run For further information, run
.PP .PP
plt-help raco docs
.PP .PP
to open installed documentation in your web browser. to open installed documentation in your web browser.
@ -48,15 +33,7 @@ Alternately, consult the on-line
documentation and other information available at documentation and other information available at
.PP .PP
.ce 1 .ce 1
http://www.plt-scheme.org/software/mzscheme/ http://www.racket-lang.org/
.SH AUTHOR
MzScheme
was implemented by Matthew Flatt (mflatt@plt-scheme.org).
It was originally based on libscheme, written by Brent Benson.
.SH SEE ALSO .SH SEE ALSO
.BR plt-help(1), .BR racket(1)
.BR drscheme(1),
.BR mred(1),
.BR setup-plt(1),
.BR mzc(1)

View File

@ -1,30 +1,18 @@
.\" dummy line .\" dummy line
.TH PLT-Help 1 "January 2008" .TH PLT-Help 1 "May 2010"
.UC 4 .UC 4
.SH NAME .SH NAME
plt-help \- The PLT Scheme documentation center plt-help \- compatibility Racket documentation tool
.SH SYNOPSIS .SH SYNOPSIS
.B plt-help .B plt-help
[\c .IR term \ ...
.I -x\c
] [\c
.I --exact\c
] [\c
.IR term \ ...]
.SH DESCRIPTION .SH DESCRIPTION
PLT Help .B plt-help
searches for term in the PLT Scheme documentation. opens or searches the Racket document. Use
It opens a locally generated HTML document in a web .B raco docs
browser with results of a search. instead of
.PP .BR plt-help.
For further information on PLT Help, run it. Alternately, consult the on-line
documentation and other information available at
.PP
.ce 1
http://www.drscheme.org/
.SH AUTHOR
PLT Help is implemented by PLT, http://www.plt-scheme.org/.
.SH SEE ALSO .SH SEE ALSO
.BR drscheme(1), .BR raco(1)
.BR mzscheme(1),
.BR mred(1)

54
man/man1/racket.1 Normal file
View File

@ -0,0 +1,54 @@
.\" dummy line
.TH RACKET 1 "May 2010"
.UC 4
.SH NAME
racket \- core Racket implementation
.SH SYNOPSIS
.B racket
[
.I option ...
] [
.I argument ...
]
.SH DESCRIPTION
Run
.PP
racket --help
.PP
for a list of command-line options and other start-up information.
.PP
Supplying no arguments to
.B racket
is the same as supplying the
.B -i
option for interactive evaluation.
.PP
Supplying a single non-switch argument to
.B racket
is the same as putting
.B -u
before the argument to run it as a module-based script.
.SH MORE INFORMATION
For further information, run
.PP
raco docs
.PP
to open installed documentation in your web browser.
.PP
Alternately, consult the on-line
documentation and other information available at
.PP
.ce 1
http://www.racket-lang.org/
.SH AUTHOR
Racket was implemented by Matthew Flatt and PLT.
It was originally based on libscheme, written by Brent Benson.
.SH SEE ALSO
.BR raco(1),
.BR drracket(1),
.BR gracket(1)

45
man/man1/raco.1 Normal file
View File

@ -0,0 +1,45 @@
.\" dummy line
.TH RACO 1 "May 2010"
.UC 4
.SH NAME
raco \- the RAcket COmmand-line tool
.SH SYNOPSIS
.B raco
[
.I option ...
] [
.I argument ...
]
.SH DESCRIPTION
.B raco
performs various tasks related to the Racket language, such as finding documentation,
compiling Racket source to bytecode,
packaging executables, and packaging installable archives.
.PP
Run
.PP
raco help
.PP
for a list of subcommands.
.SH MORE INFORMATION
For further information, run
.PP
raco docs
.PP
to open installed documentation in your web browser.
.PP
Alternately, consult the on-line
documentation and other information available at
.PP
.ce 1
http://www.racet-lang.org/
.SH AUTHOR
.B raco
was implemented by PLT.
.SH SEE ALSO
.BR racket(1),
.BR drracket(1)

View File

@ -1,8 +1,8 @@
.\" dummy line .\" dummy line
.TH SETUP-PLT 1 "January 2008" .TH SETUP-PLT 1 "May 2010"
.UC 4 .UC 4
.SH NAME .SH NAME
setup-plt \- The PLT Scheme setup tool setup-plt \- compatibility Racket setup tool
.SH SYNOPSIS .SH SYNOPSIS
.B setup-plt .B setup-plt
[ [
@ -11,9 +11,10 @@ setup-plt \- The PLT Scheme setup tool
.I argument ... .I argument ...
] ]
.SH DESCRIPTION .SH DESCRIPTION
Setup PLT .B setup-plt
performs various installation and setup tasks for a PLT Scheme provides an old interface to some Racket tools that are now
installation. normally provided via
.BR raco .
.PP .PP
Run Run
@ -25,7 +26,7 @@ for a list of command-line options.
.SH MORE INFORMATION .SH MORE INFORMATION
For further information, run For further information, run
.PP .PP
plt-help raco help
.PP .PP
to open installed documentation in your web browser. to open installed documentation in your web browser.
@ -34,12 +35,8 @@ Alternately, consult the on-line
documentation and other information available at documentation and other information available at
.PP .PP
.ce 1 .ce 1
http://www.plt-scheme.org/ http://www.racket-lang.org/
.SH AUTHOR
Setup PLT
was implemented by PLT, http://www.plt-scheme.org/.
.SH SEE ALSO .SH SEE ALSO
.BR plt-help(1), .BR raco(1),
.BR mzscheme(1), .BR racket(1)
.BR drscheme(1)