mirror of
https://github.com/roswell/roswell.git
synced 2026-09-10 07:16:17 -04:00
[ci skip] documents update
This commit is contained in:
parent
84d011bb88
commit
eaa1d4b2f4
44
documents/man/ros-init.1
Normal file
44
documents/man/ros-init.1
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
.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 [template]\f[] name
|
||||
.TP
|
||||
.B template
|
||||
Specify the name of a template.
|
||||
.RS
|
||||
.RE
|
||||
.SH Description
|
||||
.PP
|
||||
Initialises [name].ros.
|
||||
.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)
|
||||
.SH AUTHORS
|
||||
Roswell Project Team.
|
||||
Loading…
Reference in a new issue