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-13 05:08:13 +00:00
parent 39ca86e2aa
commit bb6dc43cc3
2 changed files with 25 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1,7 +1,7 @@
.TH "ros-init" "1" "" "" ""
.nh \" Turn off hyphenation by default.
.PP
ros\-init \- Create a roswell script (optionally based on a template)
ros-init - Create a roswell script (optionally based on a template)
.SH Synopsis
.PP
\f[B]ros init NAME [TEMPLATE [ARGS...]]\f[]
@ -22,7 +22,7 @@ that they should always explicitly specify the template name.
.RE
.TP
.B NAME
Specify the output filename, or "\-" to indicate \f[I]stdout\f[].
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
@ -30,20 +30,20 @@ file type ".ros".
.SH Description
.PP
Initialises a roswell file based on a template.
User\-specified templates can be added by \f[I]ros\-template\f[](1).
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\ "$\@"
#|-*-\ 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)
(in-package\ :ros.script.test.3666781082)
(defun\ main\ (&rest\ argv)
\ \ (declare\ (ignorable\ argv)))
;;;\ vim:\ set\ ft=lisp\ lisp:
@ -52,11 +52,11 @@ exec\ ros\ \-Q\ \-\-\ $0\ "$\@"
.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,
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.
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)
\f[I]sbcl\f[](1) \f[I]ros\f[](1) \f[I]ros-template\f[](1)
.SH AUTHORS
Roswell Project Team.

30
documents/man/ros-template.1
View file

@ -9,12 +9,12 @@ Register, manage and remove the templates.
The format of ARGS is same as the lambda list except the following
translation:
.IP \[bu] 2
&key, &optional, &rest corresponds to \-\-key, \-\-optional, \-\-rest,
&key, &optional, &rest corresponds to --key, --optional, --rest,
respectively.
.IP \[bu] 2
Abbreviation as \-k, \-o, \-r are available.
Abbreviation as -k, -o, -r are available.
.IP \[bu] 2
Each argument is separated by \-\-, instead of being surrounded by
Each argument is separated by --, instead of being surrounded by
parentheses.
.IP \[bu] 2
Optional and keyword arguments can have a default value.
@ -28,12 +28,12 @@ template with some arguments.
.nf
\f[C]
$\ cat\ tmpl.asd
(asdf:defsystem\ NAME\ :author\ "AUTHOR"\ :depends\-on\ DEP\ :short\-description\ "library\ by\ AUTHOR.")
$\ ros\ template\ add\ tmpl.asd\ NAME\ AUTHOR\ \-\-optional\ DEP\ "(:alexandria)"
$\ ros\ init\ result.asd\ tmpl.asd\ bob\-utilities\ Bob
(asdf:defsystem\ NAME\ :author\ "AUTHOR"\ :depends-on\ DEP\ :short-description\ "library\ by\ AUTHOR.")
$\ ros\ template\ add\ tmpl.asd\ NAME\ AUTHOR\ --optional\ DEP\ "(:alexandria)"
$\ ros\ init\ result.asd\ tmpl.asd\ bob-utilities\ Bob
Successfully\ generated:\ result.asd
$\ cat\ result.asd:
(asdf:defsystem\ bob\-utilities\ :author\ "Bob"\ :depends\-on\ (:alexandria)\ :short\-description\ "library\ by\ Bob.")
(asdf:defsystem\ bob-utilities\ :author\ "Bob"\ :depends-on\ (:alexandria)\ :short-description\ "library\ by\ Bob.")
\f[]
.fi
.PP
@ -46,9 +46,9 @@ For example,
\f[C]
$\ echo\ $USER
Bob
$\ ros\ init\ result.asd\ tmpl.asd\ bob\-utilities\ \[aq]#.(uiop:getenv\ "USER")\[aq]
$\ ros\ init\ result.asd\ tmpl.asd\ bob-utilities\ \[aq]#.(uiop:getenv\ "USER")\[aq]
$\ cat\ result.asd:
(asdf:defsystem\ bob\-utilities\ :author\ "Bob"\ :depends\-on\ (:alexandria)\ :short\-description\ "library\ by\ Bob.")
(asdf:defsystem\ bob-utilities\ :author\ "Bob"\ :depends-on\ (:alexandria)\ :short-description\ "library\ by\ Bob.")
\f[]
.fi
.PP
@ -78,19 +78,19 @@ Ensures that a template \f[I]TEMPLATE\f[] is removed.
.RE
.SH Options for \f[I]ros template add\f[]
.IP \[bu] 2
\-f,\-\-force : Overwrites the existing template with the same name
without asking
-f,--force : Overwrites the existing template with the same name without
asking
.IP \[bu] 2
\-r,\-\-recursive : register the directory recursively.
-r,--recursive : register the directory recursively.
TEMPLATE should be a directory in order to make this option meaningful.
.IP \[bu] 2
\-\-name NAME : register the template with a given name, not the
original filename.
--name NAME : register the template with a given name, not the original
filename.
.SH Misc
.PP
Registered templates are stored in directory $ROSWELL_HOME/templates/ .
.SH SEE ALSO
.PP
\f[I]ros\f[](1) \f[I]ros\-init\f[](1)
\f[I]ros\f[](1) \f[I]ros-init\f[](1)
.SH AUTHORS
Roswell Project Team.