common-lisp/roswell.roswell
1
0
Fork 0
mirror of https://github.com/roswell/roswell.git synced 2026-09-10 07:16:17 -04:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

[ci skip] documents update

Browse source
This commit is contained in:
Travis-CI 2016-04-18 12:44:07 +00:00
parent b018ab1b5f
commit cf9589ae0f
1 changed files with 23 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
documents/man/ros-init.1
View file

@ -4,15 +4,33 @@
ros-init - Create a roswell script (optionally based on a template)
.SH Synopsis
.PP
\f[B]ros init [template]\f[] name
\f[B]ros init NAME [TEMPLATE [ARGS...]]\f[]
.TP
.B template
Specify the name of a template.
.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 [name].ros.
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
@ -39,6 +57,6 @@ 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]sbcl\f[](1) \f[I]ros\f[](1) \f[I]ros-template\f[](1)
.SH AUTHORS
Roswell Project Team.