documents/ros.md -- link to the help pages of the subcommands

2026-09-10 07:16:17 -04:00 · 2016-03-12 23:19:15 +09:00 · 2016-03-12 23:19:15 +09:00 · 0a48edc8e3
parent 2586aef7a5
commit 0a48edc8e3
3 changed files with 77 additions and 64 deletions
--- a/documents/html/ros.html
+++ b/documents/html/ros.html
@ -36,40 +36,40 @@
 <dd><p>Install a given implementation (e.g. sbcl, ccl) or a system (e.g. alexandria) for roswell environment. See <em><a href="ros-install.html">ros-install</a></em>(1).</p>
 </dd>
 <dt>init [name[.ros]]</dt>
-<dd><p>Create a new ros script</p>
+<dd><p>Create a new ros script. <code>.ros</code> is optional, and is added automaticaly. See <em><a href="ros-init.html">ros-init</a></em>.</p>
 </dd>
 <dt>dump [executable|output] [script]</dt>
-<dd><p>Dump an image of the script for the faster startup or to make an executable.</p>
+<dd><p>Dump an image of the script for the faster startup or to make an executable. See <em><a href="ros-dump.html">ros-dump</a></em>.</p>
 </dd>
 <dt>build</dt>
-<dd><p>Make an executable from the script.</p>
+<dd><p>Make an executable from the script. See <em>ros-build</em>.</p>
 </dd>
 <dt>run</dt>
-<dd><p>Initiate REPL</p>
+<dd><p>Initiate REPL. See <em><a href="ros-run.html">ros-run</a></em>.</p>
 </dd>
 <dt>use</dt>
-<dd><p>Change the default implementation used by roswell.</p>
+<dd><p>Change the default implementation used by roswell. See <em><a href="ros-use.html">ros-use</a></em>.</p>
 </dd>
 <dt>list</dt>
-<dd><p>List the various informations.</p>
+<dd><p>List the various informations. See <em><a href="ros-list.html">ros-list</a></em>.</p>
 </dd>
 <dt>config</dt>
-<dd><p>Get and set the options.</p>
+<dd><p>Get and set the options. See <em><a href="ros-config.html">ros-config</a></em>.</p>
 </dd>
 <dt>setup</dt>
-<dd><p>Run the initial setup</p>
+<dd><p>Run the initial setup. See <em><a href="ros-setup.html">ros-setup</a></em>.</p>
 </dd>
 <dt>emacs</dt>
-<dd><p>Launch emacs with slime.</p>
+<dd><p>Launch emacs with slime. See <em><a href="ros-emacs.html">ros-emacs</a></em>.</p>
 </dd>
 <dt>wait</dt>
-<dd><p>Wait forever, used for daemonizing the script.</p>
+<dd><p>Wait forever, used for daemonizing the script. See <em><a href="ros-wait.html">ros-wait</a></em>.</p>
 </dd>
 <dt>delete</dt>
-<dd><p>Delete an installed implementation.</p>
+<dd><p>Delete an installed implementation. See <em><a href="ros-delete.html">ros-delete</a></em>.</p>
 </dd>
 <dt>version</dt>
-<dd><p>Show the roswell version information.</p>
+<dd><p>Show the roswell version information. See <em>ros-version</em>.</p>
 </dd>
 <dt>help</dt>
 <dd><p>Show the subcommand help.</p>
--- a/documents/man/ros.1
+++ b/documents/man/ros.1
@ -1,12 +1,12 @@
 .TH "ros" "1" "" "" ""
 .nh \" Turn off hyphenation by default.
 .PP
-Roswell - Common Lisp environment setup Utility
+Roswell \- Common Lisp environment setup Utility
 .SH Synopsis
 .IP \[bu] 2
 \f[B]ros\f[] [\f[B]options\f[]] \f[C][command\ [args...]\f[]
 .IP \[bu] 2
-\f[B]ros\f[] [\f[B]options\f[]] \f[C][--]script\ [args...]\f[]
+\f[B]ros\f[] [\f[B]options\f[]] \f[C][\-\-]script\ [args...]\f[]
 .IP \[bu] 2
 \f[B]ros\f[] [\f[B]options\f[]] < script.ros
 .SH Description
@ -14,11 +14,11 @@ Roswell - Common Lisp environment setup Utility
 Roswell is a command line tool for installing and managing Common Lisp
 implementations, as well as a scripting infrastructure for templating,
 writing, executing, compiling, distributing, downloading and installing
-ROSWELL-SCRIPTS written in Common Lisp.
+ROSWELL\-SCRIPTS written in Common Lisp.
 .PP
 Currently roswell supports sbcl, ccl, clisp and ecl as its supported
 lisp implementations.
-For further details see \f[I]ros-install\f[](1).
+For further details see \f[I]ros\-install\f[](1).
 .PP
 Scripts installed by roswell will be system wide if appropriate
 directory is included in PATH.
@ -30,68 +30,81 @@ In an order of utility/frequency.
 Install a given implementation (e.g.
 sbcl, ccl) or a system (e.g.
 alexandria) for roswell environment.
-See \f[I]ros-install\f[](1).
+See \f[I]ros\-install\f[](1).
 .RS
 .RE
 .TP
 .B init [name[.ros]]
-Create a new ros script
+Create a new ros script.
+\f[C]\&.ros\f[] is optional, and is added automaticaly.
+See \f[I]ros\-init\f[].
 .RS
 .RE
 .TP
 .B dump [executable|output] [script]
 Dump an image of the script for the faster startup or to make an
 executable.
+See \f[I]ros\-dump\f[].
 .RS
 .RE
 .TP
 .B build
 Make an executable from the script.
+See \f[I]ros\-build\f[].
 .RS
 .RE
 .TP
 .B run
-Initiate REPL
+Initiate REPL.
+See \f[I]ros\-run\f[].
 .RS
 .RE
 .TP
 .B use
 Change the default implementation used by roswell.
+See \f[I]ros\-use\f[].
 .RS
 .RE
 .TP
 .B list
 List the various informations.
+See \f[I]ros\-list\f[].
 .RS
 .RE
 .TP
 .B config
 Get and set the options.
+See \f[I]ros\-config\f[].
 .RS
 .RE
 .TP
 .B setup
-Run the initial setup
+Run the initial setup.
+See \f[I]ros\-setup\f[].
 .RS
 .RE
 .TP
 .B emacs
 Launch emacs with slime.
+See \f[I]ros\-emacs\f[].
 .RS
 .RE
 .TP
 .B wait
 Wait forever, used for daemonizing the script.
+See \f[I]ros\-wait\f[].
 .RS
 .RE
 .TP
 .B delete
 Delete an installed implementation.
+See \f[I]ros\-delete\f[].
 .RS
 .RE
 .TP
 .B version
 Show the roswell version information.
+See \f[I]ros\-version\f[].
 .RS
 .RE
 .TP
@ -101,139 +114,139 @@ Show the subcommand help.
 .RE
 .SH Options
 .PP
-Options are processed in left-to-right order.
+Options are processed in left\-to\-right order.
 .TP
-.B -w CODE --wrap CODE
+.B \-w CODE \-\-wrap CODE
 Run the script with a shell wrapper CODE, e.g.
 rlwrap
 .RS
 .RE
 .TP
-.B -m IMAGE --image IMAGE
+.B \-m IMAGE \-\-image IMAGE
 Continue from Lisp image IMAGE
 .RS
 .RE
 .TP
-.B -L NAME --lisp NAME
+.B \-L NAME \-\-lisp NAME
 Run the script with a lisp impl NAME[/VERSION] if present, e.g.
-sbcl-bin, sbcl/1.2.16.
+sbcl\-bin, sbcl/1.2.16.
 Fails otherwise.
 .RS
 .RE
 .TP
-.B -l FILE --load FILE
+.B \-l FILE \-\-load FILE
 Load a lisp file FILE while building
 .RS
 .RE
 .TP
-.B -S X --source-registry X
+.B \-S X \-\-source\-registry X
 Override the source registry of asdf systems.
 .RS
 .RE
 .TP
-.B -s SYSTEM --system SYSTEM
+.B \-s SYSTEM \-\-system SYSTEM
 Load the asdf SYSTEM while building.
 .RS
 .RE
 .TP
-.B --load-system SYSTEM
+.B \-\-load\-system SYSTEM
 Same as above (buildapp compatibility)
 .RS
 .RE
 .TP
-.B -p PACKAGE --package PACKAGE
+.B \-p PACKAGE \-\-package PACKAGE
 Change the current package to PACKAGE
 .RS
 .RE
 .TP
-.B -sp SP --system-package SP
-Combination of -s SP and -p SP
+.B \-sp SP \-\-system\-package SP
+Combination of \-s SP and \-p SP
 .RS
 .RE
 .TP
-.B -e FORM --eval FORM
+.B \-e FORM \-\-eval FORM
 Evaluate FORM while building
 .RS
 .RE
 .TP
-.B --require MODULE
+.B \-\-require MODULE
 require MODULE while building
 .RS
 .RE
 .TP
-.B -q --quit
+.B \-q \-\-quit
 quit lisp here
 .RS
 .RE
 .TP
-.B -r FUNC --restart FUNC
+.B \-r FUNC \-\-restart FUNC
 the build image restarts from calling FUNC
 .RS
 .RE
 .TP
-.B -E FUNC --entry FUNC
+.B \-E FUNC \-\-entry FUNC
 the build image restarts from calling (FUNC argv).
 .RS
 .RE
 .TP
-.B -i FORM --init FORM
+.B \-i FORM \-\-init FORM
 evaluate FORM after the restart.
 .RS
 .RE
 .TP
-.B -ip FORM --print FORM
+.B \-ip FORM \-\-print FORM
 evaluate and princ FORM after the restart
 .RS
 .RE
 .TP
-.B -iw FORM --write FORM
+.B \-iw FORM \-\-write FORM
 evaluate and write FORM after the restart
 .RS
 .RE
 .TP
-.B -F FORM --final FORM
+.B \-F FORM \-\-final FORM
 evaluate FORM before dumping the IMAGE
 .RS
 .RE
 .TP
-.B -R --rc
+.B \-R \-\-rc
 try to read /etc/rosrc, ~/.roswell/init.lisp
 .RS
 .RE
 .TP
-.B +R --no-rc
+.B +R \-\-no\-rc
 skip /etc/rosrc, ~/.roswell/init.lisp
 .RS
 .RE
 .TP
-.B -Q --quicklisp
+.B \-Q \-\-quicklisp
 load quicklisp (default)
 .RS
 .RE
 .TP
-.B +Q --no-quicklisp
+.B +Q \-\-no\-quicklisp
 do not load quicklisp
 .RS
 .RE
 .TP
-.B -v --verbose
+.B \-v \-\-verbose
 be quite verbose while building
 .RS
 .RE
 .TP
-.B --quiet
+.B \-\-quiet
 suppress output while building (default)
 .RS
 .RE
 .TP
-.B --test
+.B \-\-test
 for test purpose
 .RS
 .RE
 .TP
-.B dynamic-space-size=[size in MB]
+.B dynamic\-space\-size=[size in MB]
 SBCL specific.
-The argument is passed to SBCL by \f[C]--dynamic-space-size\f[]
+The argument is passed to SBCL by \f[C]\-\-dynamic\-space\-size\f[]
 .RS
 .RE
 .SH Environmental Variables
@ -248,7 +261,7 @@ platform .
 Check out issues list (https://github.com/roswell/roswell/issues)
 .SH SEE ALSO
 .PP
-\f[I]sbcl\f[](1) \f[I]ros-dump\f[](1) \f[I]ros-init\f[](1)
-\f[I]ros-install\f[](1) \f[I]ros-list\f[](1) \f[I]ros-setup\f[](1)
+\f[I]sbcl\f[](1) \f[I]ros\-dump\f[](1) \f[I]ros\-init\f[](1)
+\f[I]ros\-install\f[](1) \f[I]ros\-list\f[](1) \f[I]ros\-setup\f[](1)
 .SH AUTHORS
 Roswell Project Team.
--- a/documents/ros.md
+++ b/documents/ros.md
@ -24,51 +24,51 @@ install

 init [name[.ros]]

-  : Create a new ros script
+  : Create a new ros script. `.ros` is optional, and is added automaticaly. See _ros-init_.

 dump [executable|output] [script]

-  : Dump an image of the script for the faster startup or to make an executable.
+  : Dump an image of the script for the faster startup or to make an executable. See _ros-dump_.

 build

-  : Make an executable from the script.
+  : Make an executable from the script. See _ros-build_.

 run

-  : Initiate REPL
+  : Initiate REPL. See _ros-run_.

 use

-  : Change the default implementation used by roswell.
+  : Change the default implementation used by roswell. See _ros-use_.

 list

-  : List the various informations.
+  : List the various informations. See _ros-list_.

 config

-  : Get and set the options.
+  : Get and set the options. See _ros-config_.

 setup

-  : Run the initial setup
+  : Run the initial setup. See _ros-setup_.

 emacs

-  : Launch emacs with slime.
+  : Launch emacs with slime. See _ros-emacs_.

 wait

-  : Wait forever, used for daemonizing the script.
+  : Wait forever, used for daemonizing the script. See _ros-wait_.

 delete

-  : Delete an installed implementation.
+  : Delete an installed implementation. See _ros-delete_.

 version

-  : Show the roswell version information.
+  : Show the roswell version information. See _ros-version_.

 help