mirror of
https://github.com/roswell/roswell.git
synced 2026-09-10 07:16:17 -04:00
63 lines
1.8 KiB
Groff
63 lines
1.8 KiB
Groff
.TH "ros-init" "1" "" "" ""
|
|
.nh \" Turn off hyphenation by default.
|
|
.PP
|
|
ros\-init \- Create a roswell script (optionally based on a template)
|
|
.SH Synopsis
|
|
.PP
|
|
\f[B]ros init NAME [TEMPLATE [ARGS...]]\f[]
|
|
.TP
|
|
.B TEMPLATE
|
|
Specifies the name of a template, defaulted to \f[I]default\f[]
|
|
template.
|
|
However, if \f[I]TEMPLATE\f[] is not specified and \f[I]FILENAME\f[]
|
|
matches one of the templates being stored, then it automatically uses
|
|
the template.
|
|
To suppress this behavior, you should explicitly specify
|
|
\f[I]TEMPLATE\f[] as \f[I]default\f[].
|
|
.RS
|
|
.PP
|
|
Thus you are warned when you use this command from a shell script.
|
|
In order to achieve a consistent and desired behavior, it is adviced
|
|
that they should always explicitly specify the template name.
|
|
.RE
|
|
.TP
|
|
.B NAME
|
|
Specify the output filename, or "\-" to indicate \f[I]stdout\f[].
|
|
When \f[I]TEMPLATE\f[] is \f[I]default\f[], it automatically appends a
|
|
file type ".ros".
|
|
.RS
|
|
.RE
|
|
.SH Description
|
|
.PP
|
|
Initialises a roswell file based on a template.
|
|
User\-specified templates can be added by \f[I]ros\-template\f[](1).
|
|
.PP
|
|
The default template is something like:
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
#!/bin/sh
|
|
#|\-*\-\ mode:lisp\ \-*\-|#
|
|
#|\ <Put\ a\ one\-line\ description\ here>
|
|
exec\ ros\ \-Q\ \-\-\ $0\ "$\@"
|
|
|#
|
|
(defpackage\ :ros.script.test.3666781082
|
|
\ \ (:use\ :cl))
|
|
(in\-package\ :ros.script.test.3666781082)
|
|
(defun\ main\ (&rest\ argv)
|
|
\ \ (declare\ (ignorable\ argv)))
|
|
;;;\ vim:\ set\ ft=lisp\ lisp:
|
|
\f[]
|
|
.fi
|
|
.PP
|
|
This is basically a shell script which immediately invokes Roswell by
|
|
exec (see \f[I]sh(1)\f[]).
|
|
Roswell loads the same script as an input, skips multi\-line comments,
|
|
reads the rest of the file as a Common Lisp program, and finally invokes
|
|
a function main with command\-line arguments.
|
|
.SH SEE ALSO
|
|
.PP
|
|
\f[I]sbcl\f[](1) \f[I]ros\f[](1) \f[I]ros\-template\f[](1)
|
|
.SH AUTHORS
|
|
Roswell Project Team.
|