diff --git a/documents/man/ros-init.1 b/documents/man/ros-init.1 index 22c4f23..5890ae5 100644 --- a/documents/man/ros-init.1 +++ b/documents/man/ros-init.1 @@ -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.