From 1c8e46de178e969a0f1eeb23e0e44028c0fa22c1 Mon Sep 17 00:00:00 2001 From: github actions Date: Sun, 20 Feb 2022 06:14:59 +0000 Subject: [PATCH] [ci skip] documents update --- documents/html/ros-build.html | 2 +- documents/html/ros-checkout.html | 2 +- documents/html/ros-client.html | 4 +- documents/html/ros-config.html | 4 +- documents/html/ros-delete.html | 8 +- documents/html/ros-dist.html | 2 +- documents/html/ros-dump.html | 36 +++--- documents/html/ros-emacs.html | 2 +- documents/html/ros-init.html | 4 +- documents/html/ros-install.html | 6 +- documents/html/ros-list.html | 2 +- documents/html/ros-serve.html | 2 +- documents/html/ros-template.html | 16 +-- documents/html/ros-update.html | 4 +- documents/html/ros-use.html | 4 +- documents/html/ros.html | 56 ++++----- documents/man/ros-asdf.1 | 8 +- documents/man/ros-build.1 | 10 +- documents/man/ros-checkout.1 | 6 +- documents/man/ros-client.1 | 24 ++-- documents/man/ros-config.1 | 12 +- documents/man/ros-delete.1 | 19 ++- documents/man/ros-dist.1 | 6 +- documents/man/ros-dump.1 | 141 +++++++++------------ documents/man/ros-emacs.1 | 6 +- documents/man/ros-help.1 | 8 +- documents/man/ros-init.1 | 53 ++++---- documents/man/ros-install.1 | 88 +++++++------- documents/man/ros-list.1 | 18 +-- documents/man/ros-run.1 | 8 +- documents/man/ros-serve.1 | 22 ++-- documents/man/ros-setup.1 | 14 +-- documents/man/ros-template.1 | 202 +++++++++++++------------------ documents/man/ros-update.1 | 20 ++- documents/man/ros-use.1 | 36 +++--- documents/man/ros-wait.1 | 10 +- documents/man/ros.1 | 192 +++++++++-------------------- 37 files changed, 444 insertions(+), 613 deletions(-) diff --git a/documents/html/ros-build.html b/documents/html/ros-build.html index 9ebb15b..ac3d489 100644 --- a/documents/html/ros-build.html +++ b/documents/html/ros-build.html @@ -18,7 +18,7 @@
  • Roswell Project Team
    • -

    ros-build - Shortcut to "ros dump executable" # synopsis

    +

    ros-build - Shortcut to “ros dump executable” # synopsis

    ros [options] build

    Equivalent to calling ros dump executable <file>.

    diff --git a/documents/html/ros-checkout.html b/documents/html/ros-checkout.html index d8428fc..d18f427 100644 --- a/documents/html/ros-checkout.html +++ b/documents/html/ros-checkout.html @@ -19,7 +19,7 @@

    ros-checkout - # synopsis

    -

    ros [options] checkout args...

    +

    ros [options] checkout args…

    diff --git a/documents/html/ros-client.html b/documents/html/ros-client.html index 92d321d..87adf66 100644 --- a/documents/html/ros-client.html +++ b/documents/html/ros-client.html @@ -20,7 +20,7 @@

    ros-client - one-shot connect to remote repl.

    synopsis

    -

    ros client protocol [options for the protocol ...] ...

    +

    ros client protocol [options for the protocol …] …

    @@ -34,7 +34,7 @@
    --interface interface

    interface for connect. default is localhost.

    -
    -e FORM --eval FORM
    +
    -e FORM –eval FORM

    Evaluate FORM while building

    diff --git a/documents/html/ros-config.html b/documents/html/ros-config.html index 2490167..f5505ed 100644 --- a/documents/html/ros-config.html +++ b/documents/html/ros-config.html @@ -19,9 +19,9 @@

    ros-config - get and set options # Synopsis

    -

    ros [options] config [SUBCOMMAND ARGS...]

    +

    ros [options] config [SUBCOMMAND ARGS…]

    Description

    -

    Without any arguments, it shows all variables and it's value.

    +

    Without any arguments, it shows all variables and it’s value.

    show TARGET

    show TARGET.

    diff --git a/documents/html/ros-delete.html b/documents/html/ros-delete.html index f246a3a..192c1b9 100644 --- a/documents/html/ros-delete.html +++ b/documents/html/ros-delete.html @@ -19,14 +19,14 @@

    ros-delete - # synopsis

    -

    ros delete ARGS...

    +

    ros delete ARGS…

    Slightly complex arguments.

    -

    ros delete dump IMAGES...

    +

    ros delete dump IMAGES…

    Whem ARGS starts with dump, it considers the remaining args as the names for the dumped images. It then deletes the image with the given name, if it exists.

    The deletion happens only to the images compatible with the current lisp implementation/version. For example, when ccl-bin/1.10 and sbcl-bin/1.3.1 both have images named X, and if the current lisp in use is sbcl-bin/1.3.1, then ros delete dump X removes sbcl-bin/1.3.1/X only.

    -

    ros delete IMPLS...

    +

    ros delete IMPLS…

    When the first argument is not dump, then the arguments are treated as a list of installed implementations.

    -

    If a name of some implementation is given without version specifiers, e.g. sbcl-bin, then it removes all instances (versions) of sbcl-bin.

    +

    If a name of some implementation is given without version specifiers, e.g. sbcl-bin, then it removes all instances (versions) of sbcl-bin.

    If a version is specified, then it removes only the specified instance.

    diff --git a/documents/html/ros-dist.html b/documents/html/ros-dist.html index 3a2088b..116de3a 100644 --- a/documents/html/ros-dist.html +++ b/documents/html/ros-dist.html @@ -19,7 +19,7 @@

    ros-dist - # synopsis

    -

    ros [options] dist args...

    +

    ros [options] dist args…

    diff --git a/documents/html/ros-dump.html b/documents/html/ros-dump.html index 48743cd..09b91af 100644 --- a/documents/html/ros-dump.html +++ b/documents/html/ros-dump.html @@ -20,11 +20,11 @@

    ros-dump - make a dumped image of a roswell script

    Synopsis

    -

    ros [OPTIONS1...] dump [OPTIONS2...] MODE args...

    +

    ros [OPTIONS1…] dump [OPTIONS2…] MODE args…

    OPTIONS1 specify the standard roswell options such as -L or -m LISP. OPTIONS2 specify the image reduction options we describe later. MODE is either output or executable.

    Description

    ros-dump creates a dumped lisp image of the state after processing all options OPTIONS1.

    -

    It has two modes output and executable. In both modes, the global environment (e.g. global binding to special variables such as *package*) of the state just after the restart is the environment which was effective when the script was dumped.

    +

    It has two modes output and executable. In both modes, the global environment (e.g. global binding to special variables such as *package*) of the state just after the restart is the environment which was effective when the script was dumped.

    @@ -52,37 +52,37 @@

    Care should be taken to ensure the resulting program works as expected, as some of these operation may destroy the common assumptions of the conforming programs. For example, package-related reduction options may inhibit the runtime calls to READ after the restart.

    Reduction options are processed in the left-to-right manner.

    -
    --disable-compression, --enable-compression, -c
    +
    –disable-compression, –enable-compression, -c

    These options disable/enable/enable the core compression feature in SBCL. Thus this option is meaningful only on SBCL. Compression is enabled by default.

    -
    --remove-docstrings
    +
    –remove-docstrings

    This option removes all docstrings from all symbols in the entire lisp image.

    -
    --delete-package PKG
    -

    This option can be specified multiple times. It uninterns the symbols in PACKAGE, calls makeunbound and fmakeunbound on each symbol and deletes the package. Package names are automatically string-upcase'd.

    +
    –delete-package PKG
    +

    This option can be specified multiple times. It uninterns the symbols in PACKAGE, calls makeunbound and fmakeunbound on each symbol and deletes the package. Package names are automatically string-upcase’d.

    -
    --delete-all-packages
    -

    This option applies --delete-package PKG on all packages, except some blacklisted packages (keyword, roswell, ROS.SCRIPT.DUMP, and the package of the main function symbol).

    +
    –delete-all-packages
    +

    This option applies –delete-package PKG on all packages, except some blacklisted packages (keyword, roswell, ROS.SCRIPT.DUMP, and the package of the main function symbol).

    -
    --delete-packages-except PACKAGE
    -

    This option can be specified multiple times. It is identical to --delete-all-packages except that it adds PACKAGE to the blacklist. Package names are automatically string-upcase'd.

    +
    –delete-packages-except PACKAGE
    +

    This option can be specified multiple times. It is identical to –delete-all-packages except that it adds PACKAGE to the blacklist. Package names are automatically string-upcase’d.

    -
    --destroy-packages-sbcl
    -

    This is an sbcl-specific option which is even more aggressive than the above methods (>10MB reduction). It destroys the package system by modifying the internal tables for packages, cleaning up the caches for package-use-list etc. The blacklist is shared among --delete-all-packages and --destroy-packages-sbcl. However, this method does not call fmakunbound/makunbound, so combining the two methods can result in a more aggressive image size reduction. Due to the nature of this option, it is desirable to specify it as the last method (i.e. rightmost).

    +
    –destroy-packages-sbcl
    +

    This is an sbcl-specific option which is even more aggressive than the above methods (>10MB reduction). It destroys the package system by modifying the internal tables for packages, cleaning up the caches for package-use-list etc. The blacklist is shared among –delete-all-packages and –destroy-packages-sbcl. However, this method does not call fmakunbound/makunbound, so combining the two methods can result in a more aggressive image size reduction. Due to the nature of this option, it is desirable to specify it as the last method (i.e. rightmost).

    -
    --purify, --no-purify
    +
    –purify, –no-purify

    This is common to CCL, SBCL, CMUCL. Moves all objects to the static space where GC does not scan, for the later performance of GC. Purification is enabled by default.

    -
    --impurify, --no-impurify
    -

    This is an CCL-specific option (enabled by default). It moves all objects to the dynamic space before saving the image. This allows the static-space objects to be GC'ed. When purification is enabled, it impurifies all objects before running the purifying GC.

    +
    –impurify, –no-impurify
    +

    This is an CCL-specific option (enabled by default). It moves all objects to the dynamic space before saving the image. This allows the static-space objects to be GC’ed. When purification is enabled, it impurifies all objects before running the purifying GC.

    -
    --delete-debug-info
    +
    –delete-debug-info

    This removes the debug infomation of functions (used to show the stack frame etc), as well as the source locations and the deprecation information of various symbols. SBCL only. This option has a large effect (+10MB reduction).

    -
    --delete-macro-definitions, --delete-compiler-macro-definitions
    +
    –delete-macro-definitions, –delete-compiler-macro-definitions

    This removes all definitions of macros and compiler-macros, assuming that no runtime compilation/interpretation of code will be performed. This option should be portable across implementations. It has ~2MB reduction on SBCL.

    -
    --delete-compiler-information-sbcl
    +
    –delete-compiler-information-sbcl

    This is an SBCL-specific option which is more aggressive than the above methods (~4MB reduction). In addition to the macro and the compiler-macro definitions, it destroys the internal compiler systems of SBCL by also removing the inlining information, IR1 transformer and IR2 (VOP).

    diff --git a/documents/html/ros-emacs.html b/documents/html/ros-emacs.html index 2c1efae..3110b47 100644 --- a/documents/html/ros-emacs.html +++ b/documents/html/ros-emacs.html @@ -19,7 +19,7 @@

    ros-emacs - launch Emacs with Slime # Synopsis

    -

    ros emacs [ARGS...]

    +

    ros emacs [ARGS…]

    diff --git a/documents/html/ros-init.html b/documents/html/ros-init.html index eb9ff64..cdf62ce 100644 --- a/documents/html/ros-init.html +++ b/documents/html/ros-init.html @@ -20,14 +20,14 @@

    ros-init - Create a roswell script (optionally based on a template)

    Synopsis

    -

    ros init [TEMPLATE] NAME [ARGS...]]

    +

    ros init [TEMPLATE] NAME [ARGS…]]

    TEMPLATE

    Specifies the name of a template, defaulted to default template. However, if TEMPLATE is not specified and FILENAME matches one of the templates being stored, then it automatically uses the template. To suppress this behavior, you should explicitly specify TEMPLATE as default.

    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.

    NAME
    -

    Specify the output filename, or "-" to indicate stdout. When TEMPLATE is default, it automatically appends a file type ".ros".

    +

    Specify the output filename, or “-” to indicate stdout. When TEMPLATE is default, it automatically appends a file type “.ros”.

    diff --git a/documents/html/ros-install.html b/documents/html/ros-install.html index 4912492..bd094ae 100644 --- a/documents/html/ros-install.html +++ b/documents/html/ros-install.html @@ -21,8 +21,8 @@

    ros-install - Install lisp implementations or quicklisp system

    Synopsis

      -
    • ros install system [system ...]
      • -
    • ros install impl[/version] [param ...]
      • +
    • ros install system [system …]
      • +
    • ros install impl[/version] [param …]

    Description

    @@ -52,7 +52,7 @@ ccl-bin sbcl-bin

    The name can be optionally followed by a slash / and a version of the implementation.

    $ ros install sbcl/1.2.14
    -

    There might be some hidden implementation that are not listed here --- they are in the alpha quality, but try the one you like or watch the website (https://github.com/roswell/roswell).

    +

    There might be some hidden implementation that are not listed here — they are in the alpha quality, but try the one you like or watch the website (https://github.com/roswell/roswell).

    $ ros install ccl
 $ ros install abcl
 $ ...
    diff --git a/documents/html/ros-list.html b/documents/html/ros-list.html index 19f6c5a..9ec0e7d 100644 --- a/documents/html/ros-list.html +++ b/documents/html/ros-list.html @@ -27,7 +27,7 @@

    Description

    ros list shows the list of the materials installed by roswell.

    -
    installed [ [ IMPL | IMPL/VERSION ]...]
    +
    installed [ [ IMPL | IMPL/VERSION ]…]

    List the implementations that have been already installed. Optionally providing IMPL shows the installed versions of the implementation.

    dump [IMPL]
    diff --git a/documents/html/ros-serve.html b/documents/html/ros-serve.html index 9959ede..414cce8 100644 --- a/documents/html/ros-serve.html +++ b/documents/html/ros-serve.html @@ -20,7 +20,7 @@

    ros-serve - start lisp server

    Synopsis

    -

    ros [options for roswell ... ] serve protocol [options for the protocol ...] ...

    +

    ros [options for roswell … ] serve protocol [options for the protocol …] …

    diff --git a/documents/html/ros-template.html b/documents/html/ros-template.html index 9ac61e3..335ffb7 100644 --- a/documents/html/ros-template.html +++ b/documents/html/ros-template.html @@ -21,7 +21,7 @@

    ros-template - Edit template for ros-init

    synopsis

      -
    • ros template command args...
      • +
    • ros template command args…

    Subcommands

    @@ -37,25 +37,25 @@
    checkout [template-name]

    When invoked without template-name,this command shows candidates for current templates to operate.If with template-name, this command choose the name as current template.

    -
    add [template-name] [files ...]
    +
    add [template-name] [files …]

    Add files to current template.First parameter could taken as a template-name when current template are default.

    -
    cat [template-name] [files ...]
    +
    cat [template-name] [files …]

    Show contents in the current template.

    -
    edit [template-name] [files ...]
    +
    edit [template-name] [files …]

    Edit content of files in template using /usr/bin/editor.

    -
    path [template-name] [files ...]
    +
    path [template-name] [files …]

    Show native path of files in template.

    -
    rm [template-name] [files ...]
    +
    rm [template-name] [files …]

    Remove file form current template.

    -
    type [template-name] [type] [files ...]
    +
    type [template-name] [type] [files …]

    Change file type. current choice for types are djula or copy {{name}} {{author}} {{email}} {{universal_time}} are available variable in the template file. Withoug files, change default type.

    -
    chmod [template-name] [mode] [files ...]
    +
    chmod [template-name] [mode] [files …]

    Change file mode bits to generate. specify mode in octal format.

    rewrite [template-name] file rewrite-rule
    diff --git a/documents/html/ros-update.html b/documents/html/ros-update.html index db23605..e6e732f 100644 --- a/documents/html/ros-update.html +++ b/documents/html/ros-update.html @@ -21,8 +21,8 @@

    ros-update - Update system installed from vcs

    Synopsis

      -
    • ros update system [system ...]
      • -
    • ros update method [params ...]
      • +
    • ros update system [system …]
      • +
    • ros update method [params …]

    Description

    diff --git a/documents/html/ros-use.html b/documents/html/ros-use.html index c204406..00e99a0 100644 --- a/documents/html/ros-use.html +++ b/documents/html/ros-use.html @@ -21,10 +21,10 @@

    ros-use - sets the default implementation used by roswell # synopsis

    ros [options] use impl[/version]

    impl : The name of an implementation which is already installed. New implementations can be downloaded by ros-install(1). The list of installed implementations is available in ros-list(1).

    -

    version: : The version specifier. The string representation of the version (e.g. .) depends on each implementation and roswell generally follows the representation used by the implementation. In addition, a special version name "system" tells roswell to use the implementation that is installed in your system, which should be in PATH.

    +

    version: : The version specifier. The string representation of the version (e.g. .) depends on each implementation and roswell generally follows the representation used by the implementation. In addition, a special version name “system” tells roswell to use the implementation that is installed in your system, which should be in PATH.

    example

    ros use sbcl : use the latest SBCL among several versions of SBCLs installed by ros-install. This is compiled from the source, which may take some time to install but allows SLIME to jump to the implementation source code.

    -

    ros use sbcl-bin : use the latest stable SBCL binary downloaded from vendor's website. Roswell uses this by default. sbcl-bin tends to be an older version compared to sbcl, but surely newer than your apt-get installed counterpart!

    +

    ros use sbcl-bin : use the latest stable SBCL binary downloaded from vendor’s website. Roswell uses this by default. sbcl-bin tends to be an older version compared to sbcl, but surely newer than your apt-get installed counterpart!

    ros use sbcl/1.3.1 : use the compiled SBCL 1.3.1.

    ros use sbcl-bin/1.3.1 : use the prebuilt SBCL 1.3.1.

    ros use sbcl/system : use the SBCL available in the PATH.

    diff --git a/documents/html/ros.html b/documents/html/ros.html index a490097..f18f561 100644 --- a/documents/html/ros.html +++ b/documents/html/ros.html @@ -33,7 +33,7 @@

    In an order of utility/frequency.

    install
    -

    Install a given implementation (e.g. sbcl, ccl) or a system (e.g. alexandria) for roswell environment. See ros-install(1).

    +

    Install a given implementation (e.g. sbcl, ccl) or a system (e.g. alexandria) for roswell environment. See ros-install(1).

    init [name[.ros]]

    Create a new ros script. .ros is optional, and is added automaticaly. See ros-init.

    @@ -78,79 +78,79 @@

    Options

    Options are processed in left-to-right order.

    -
    -w CODE --wrap CODE
    -

    Run the script with a shell wrapper CODE, e.g. rlwrap

    +
    -w CODE –wrap CODE
    +

    Run the script with a shell wrapper CODE, e.g. rlwrap

    -
    -m IMAGE --image IMAGE
    +
    -m IMAGE –image IMAGE

    Continue from Lisp image IMAGE

    -
    -L NAME --lisp NAME
    -

    Run the script with a lisp impl NAME[/VERSION] if present, e.g. sbcl-bin, sbcl/1.2.16. Fails otherwise.

    +
    -L NAME –lisp NAME
    +

    Run the script with a lisp impl NAME[/VERSION] if present, e.g. sbcl-bin, sbcl/1.2.16. Fails otherwise.

    -
    -l FILE --load FILE
    +
    -l FILE –load FILE

    Load a lisp file FILE while building

    -
    -S X --source-registry X
    +
    -S X –source-registry X

    Override the source registry of asdf systems.

    -
    -s SYSTEM --system SYSTEM
    +
    -s SYSTEM –system SYSTEM

    Load the asdf SYSTEM while building.

    -
    --load-system SYSTEM
    +
    –load-system SYSTEM

    Same as above (buildapp compatibility)

    -
    -p PACKAGE --package PACKAGE
    +
    -p PACKAGE –package PACKAGE

    Change the current package to PACKAGE

    -
    -sp SP --system-package SP
    +
    -sp SP –system-package SP

    Combination of -s SP and -p SP

    -
    -e FORM --eval FORM
    +
    -e FORM –eval FORM

    Evaluate FORM while building

    -
    --require MODULE
    +
    –require MODULE

    require MODULE while building

    -
    -q --quit
    +
    -q –quit

    quit lisp here

    -
    -r FUNC --restart FUNC
    +
    -r FUNC –restart FUNC

    the build image restarts from calling FUNC

    -
    -E FUNC --entry FUNC
    +
    -E FUNC –entry FUNC

    the build image restarts from calling (FUNC argv).

    -
    -i FORM --init FORM
    +
    -i FORM –init FORM

    evaluate FORM after the restart.

    -
    -ip FORM --print FORM
    +
    -ip FORM –print FORM

    evaluate and princ FORM after the restart

    -
    -iw FORM --write FORM
    +
    -iw FORM –write FORM

    evaluate and write FORM after the restart

    -
    -F FORM --final FORM
    +
    -F FORM –final FORM

    evaluate FORM before dumping the IMAGE

    -
    -R --rc
    +
    -R –rc

    try to read /etc/rosrc, ~/.roswell/init.lisp

    -
    +R --no-rc
    +
    +R –no-rc

    skip /etc/rosrc, ~/.roswell/init.lisp

    -
    -Q --quicklisp
    +
    -Q –quicklisp

    load quicklisp (default)

    -
    +Q --no-quicklisp
    +
    +Q –no-quicklisp

    do not load quicklisp

    -
    -v --verbose
    +
    -v –verbose

    be quite verbose while building

    -
    --quiet
    +
    –quiet

    suppress output while building (default)

    -
    --test
    +
    –test

    for test purpose

    dynamic-space-size=[size in MB]
    diff --git a/documents/man/ros-asdf.1 b/documents/man/ros-asdf.1 index a674ea7..c444c16 100644 --- a/documents/man/ros-asdf.1 +++ b/documents/man/ros-asdf.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 1.16.0.2 +.\" Automatically generated by Pandoc 2.5 .\" .TH "ros-asdf" "1" "January 2022" "" "" .hy @@ -7,13 +7,13 @@ ros\-asdf \- .SH SYNOPSIS .PP -\f[B]ros [options] asdf [subcommand]\f[] +\f[B]ros [options] asdf [subcommand]\f[R] .SH DESCRIPTION .PP -\f[B]ros asdf\f[] install and manage +\f[B]ros asdf\f[R] install and manage ASDF(https://common\-lisp.net/project/asdf/). .SH SEE ALSO .PP -\f[I]ros\f[](1) +\f[I]ros\f[R](1) .SH AUTHORS Roswell Project Team. diff --git a/documents/man/ros-build.1 b/documents/man/ros-build.1 index e8badf3..95f6dcb 100644 --- a/documents/man/ros-build.1 +++ b/documents/man/ros-build.1 @@ -1,16 +1,16 @@ -.\" Automatically generated by Pandoc 1.16.0.2 +.\" Automatically generated by Pandoc 2.5 .\" .TH "ros-build" "1" "" "" "" .hy .PP -ros\-build \- Shortcut to "ros dump executable" # synopsis +ros\-build \- Shortcut to \[lq]ros dump executable\[rq] # synopsis .PP -\f[B]ros [options] build\f[] +\f[B]ros [options] build\f[R] .PP -Equivalent to calling \f[C]ros\ dump\ executable\ \f[]. +Equivalent to calling \f[C]ros dump executable \f[R]. .SH description .SH SEE ALSO .PP -\f[I]ros\f[](1) +\f[I]ros\f[R](1) .SH AUTHORS Roswell Project Team. diff --git a/documents/man/ros-checkout.1 b/documents/man/ros-checkout.1 index fcadb4e..ea6df11 100644 --- a/documents/man/ros-checkout.1 +++ b/documents/man/ros-checkout.1 @@ -1,16 +1,16 @@ -.\" Automatically generated by Pandoc 1.16.0.2 +.\" Automatically generated by Pandoc 2.5 .\" .TH "ros-checkout" "1" "" "" "" .hy .PP ros\-checkout \- # synopsis .PP -\f[B]ros [options] checkout\f[] args... +\f[B]ros [options] checkout\f[R] args\&... .SH description .PP to enable this command ros install roswell/ql\-checkout is needed. .SH SEE ALSO .PP -\f[I]ros\f[](1) +\f[I]ros\f[R](1) .SH AUTHORS Roswell Project Team. diff --git a/documents/man/ros-client.1 b/documents/man/ros-client.1 index c567851..f6649e0 100644 --- a/documents/man/ros-client.1 +++ b/documents/man/ros-client.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 1.16.0.2 +.\" Automatically generated by Pandoc 2.5 .\" .TH "ros-client" "1" "" "" "" .hy @@ -6,31 +6,25 @@ ros\-client \- one\-shot connect to remote repl. .SH synopsis .PP -\f[B]ros client\f[] protocol [options for the protocol ...] ... +\f[B]ros client\f[R] protocol [options for the protocol \&...] \&... .SH description .PP -\f[C]ros\-client\f[] send message to lisp server and wait for message +\f[C]ros\-client\f[R] send message to lisp server and wait for message sent back. .SH swank protocol options .TP -.B \f[C]\-\-port\ port\f[] -set server \f[C]port\f[] to connect. +.B \f[C]\-\-port port\f[R] +set server \f[C]port\f[R] to connect. default port 4005. -.RS -.RE .TP -.B \f[C]\-\-interface\ interface\f[] +.B \f[C]\-\-interface interface\f[R] interface for connect. -default is \f[C]localhost\f[]. -.RS -.RE +default is \f[C]localhost\f[R]. .TP -.B \-e FORM \-\-eval FORM +.B \-e FORM \[en]eval FORM Evaluate FORM while building -.RS -.RE .SH SEE ALSO .PP -\f[I]ros\f[](1) \f[I]ros\-serve\f[](1) +\f[I]ros\f[R](1) \f[I]ros\-serve\f[R](1) .SH AUTHORS Roswell Project Team. diff --git a/documents/man/ros-config.1 b/documents/man/ros-config.1 index 33b59a7..5532c0a 100644 --- a/documents/man/ros-config.1 +++ b/documents/man/ros-config.1 @@ -1,26 +1,22 @@ -.\" Automatically generated by Pandoc 1.16.0.2 +.\" Automatically generated by Pandoc 2.5 .\" .TH "ros-config" "1" "" "" "" .hy .PP ros\-config \- get and set options # Synopsis .PP -\f[B]ros [options] config\f[] [SUBCOMMAND ARGS...] +\f[B]ros [options] config\f[R] [SUBCOMMAND ARGS\&...] .SH Description .PP -Without any arguments, it shows all variables and it\[aq]s value. +Without any arguments, it shows all variables and it\[cq]s value. .TP .B show TARGET show TARGET. -.RS -.RE .TP .B set TARGET VALUE set the VALUE to the TARGET. -.RS -.RE .SH SEE ALSO .PP -\f[I]ros\f[](1) +\f[I]ros\f[R](1) .SH AUTHORS Roswell Project Team. diff --git a/documents/man/ros-delete.1 b/documents/man/ros-delete.1 index 9650bd5..c136762 100644 --- a/documents/man/ros-delete.1 +++ b/documents/man/ros-delete.1 @@ -1,16 +1,16 @@ -.\" Automatically generated by Pandoc 1.16.0.2 +.\" Automatically generated by Pandoc 2.5 .\" .TH "ros-delete" "1" "" "" "" .hy .PP ros\-delete \- # synopsis .PP -\f[B]ros delete\f[] ARGS... +\f[B]ros delete\f[R] ARGS\&... .PP Slightly complex arguments. -.SS ros delete dump IMAGES... +.SS ros delete dump IMAGES\&... .PP -Whem ARGS starts with \f[C]dump\f[], it considers the remaining args as +Whem ARGS starts with \f[C]dump\f[R], it considers the remaining args as the names for the dumped images. It then deletes the image with the given name, if it exists. .PP @@ -18,20 +18,19 @@ The deletion happens only to the images compatible with the current lisp implementation/version. For example, when ccl\-bin/1.10 and sbcl\-bin/1.3.1 both have images named X, and if the current lisp in use is sbcl\-bin/1.3.1, then -\f[C]ros\ delete\ dump\ X\f[] removes sbcl\-bin/1.3.1/X only. -.SS ros delete IMPLS... +\f[C]ros delete dump X\f[R] removes sbcl\-bin/1.3.1/X only. +.SS ros delete IMPLS\&... .PP -When the first argument is not \f[C]dump\f[], then the arguments are +When the first argument is not \f[C]dump\f[R], then the arguments are treated as a list of installed implementations. .PP If a name of some implementation is given without version specifiers, -e.g. -sbcl\-bin, then it removes all instances (versions) of sbcl\-bin. +e.g.\ sbcl\-bin, then it removes all instances (versions) of sbcl\-bin. .PP If a version is specified, then it removes only the specified instance. .SH description .SH SEE ALSO .PP -\f[I]ros\f[](1) +\f[I]ros\f[R](1) .SH AUTHORS Roswell Project Team. diff --git a/documents/man/ros-dist.1 b/documents/man/ros-dist.1 index 0e64081..414d91f 100644 --- a/documents/man/ros-dist.1 +++ b/documents/man/ros-dist.1 @@ -1,14 +1,14 @@ -.\" Automatically generated by Pandoc 1.16.0.2 +.\" Automatically generated by Pandoc 2.5 .\" .TH "ros-dist" "1" "" "" "" .hy .PP ros\-dist \- # synopsis .PP -\f[B]ros [options] dist\f[] args... +\f[B]ros [options] dist\f[R] args\&... .SH description .SH SEE ALSO .PP -\f[I]ros\f[](1) +\f[I]ros\f[R](1) .SH AUTHORS Roswell Project Team. diff --git a/documents/man/ros-dump.1 b/documents/man/ros-dump.1 index b4adaaa..5acd0e1 100644 --- a/documents/man/ros-dump.1 +++ b/documents/man/ros-dump.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 1.16.0.2 +.\" Automatically generated by Pandoc 2.5 .\" .TH "ros-dump" "1" "" "" "" .hy @@ -6,67 +6,65 @@ ros\-dump \- make a dumped image of a roswell script .SH Synopsis .PP -\f[B]ros [OPTIONS1...] dump [OPTIONS2...] MODE\f[] args... +\f[B]ros [OPTIONS1\&...] dump [OPTIONS2\&...] MODE\f[R] args\&... .PP -\f[C]OPTIONS1\f[] specify the standard roswell options such as -\f[C]\-L\f[] or \f[C]\-m\ LISP\f[]. -\f[C]OPTIONS2\f[] specify the image reduction options we describe later. -\f[C]MODE\f[] is either \f[C]output\f[] or \f[C]executable\f[]. +\f[C]OPTIONS1\f[R] specify the standard roswell options such as +\f[C]\-L\f[R] or \f[C]\-m LISP\f[R]. +\f[C]OPTIONS2\f[R] specify the image reduction options we describe +later. +\f[C]MODE\f[R] is either \f[C]output\f[R] or \f[C]executable\f[R]. .SH Description .PP -\f[C]ros\-dump\f[] creates a dumped lisp image of the state after -processing all options \f[C]OPTIONS1\f[]. +\f[C]ros\-dump\f[R] creates a dumped lisp image of the state after +processing all options \f[C]OPTIONS1\f[R]. .PP -It has two modes \f[C]output\f[] and \f[C]executable\f[]. -In both modes, the global environment (e.g. -global binding to special variables such as \f[C]*package*\f[]) of the -state just after the restart is the environment which was effective when -the script was dumped. +It has two modes \f[C]output\f[R] and \f[C]executable\f[R]. +In both modes, the global environment (e.g.\ global binding to special +variables such as \f[C]*package*\f[R]) of the state just after the +restart is the environment which was effective when the script was +dumped. .PP The dumped image is generally not compatible between the different implementations, and also between the versions. .SH Dump modes .SS output [\-f] [\-o OUTPUT] NAME .PP -It loads the roswell script \f[C]NAME\f[] and saves the current lisp +It loads the roswell script \f[C]NAME\f[R] and saves the current lisp state to an image. .PP The image file is by default written to an internal directory of roswell in an organized manner, i.e., somewhere under -\f[C]$ROSWELL_INSTALL_DIR\f[] deduced by the current implementation, its -version and the given NAME. +\f[C]$ROSWELL_INSTALL_DIR\f[R] deduced by the current implementation, +its version and the given NAME. .PP When the output file already exists, the command fails with an error code. .PP -The image can be loaded by \f[C]ros\ \-m\ IMAGE\f[]. +The image can be loaded by \f[C]ros \-m IMAGE\f[R]. When restarting from the image, standard roswell subcommands and additional arguments to the script are also available, for example -\f[C]ros\ run\f[] to resume with a repl, or \f[C]\-\-restart\ FUNC\f[] +\f[C]ros run\f[R] to resume with a repl, or \f[C]\-\-restart FUNC\f[R] to call a specific function, leaving some flexibility. .TP -.B \f[C]\-o\ OUTPUT\f[] -The image is written to \f[C]OUTPUT\f[] instead of the default location. -.RS -.RE +.B \f[C]\-o OUTPUT\f[R] +The image is written to \f[C]OUTPUT\f[R] instead of the default +location. .TP -.B \f[C]\-f\f[] +.B \f[C]\-f\f[R] Force output when the output already exists. -.RS -.RE .SS executable NAME [\-o OUTPUT] .PP -When a script is dumped with \f[C]executable\f[], the dumped image +When a script is dumped with \f[C]executable\f[R], the dumped image becomes an self\-contained executable binary which implies -\f[C]\-\-restart\ main\f[]. +\f[C]\-\-restart main\f[R]. .PP -If \f[C]OUTPUT\f[] is given, the resulting binary is written to this +If \f[C]OUTPUT\f[R] is given, the resulting binary is written to this file. -Otherwise, the output filename is deduced from \f[C]NAME\f[] and is +Otherwise, the output filename is deduced from \f[C]NAME\f[R] and is written in the same directory. -On Windows and if \f[C]SCRIPT\f[] has \f[C]\&.ros\f[] extension, the -filename will be \f[C]SCRIPT.exe\f[]. -On the other systems, the result will be \f[C]SCRIPT\f[] (without +On Windows and if \f[C]SCRIPT\f[R] has \f[C].ros\f[R] extension, the +filename will be \f[C]SCRIPT.exe\f[R]. +On the other systems, the result will be \f[C]SCRIPT\f[R] (without extension). .PP This feature is supported on SBCL, CCL, CMUCL, CLISP, ECL. @@ -80,106 +78,83 @@ Care should be taken to ensure the resulting program works as expected, as some of these operation may destroy the common assumptions of the conforming programs. For example, package\-related reduction options may inhibit the runtime -calls to \f[C]READ\f[] after the restart. +calls to \f[C]READ\f[R] after the restart. .PP Reduction options are processed in the left\-to\-right manner. .TP -.B \-\-disable\-compression, \-\-enable\-compression, \-c +.B \[en]disable\-compression, \[en]enable\-compression, \-c These options disable/enable/enable the core compression feature in SBCL. Thus this option is meaningful only on SBCL. Compression is enabled by default. -.RS -.RE .TP -.B \-\-remove\-docstrings +.B \[en]remove\-docstrings This option removes all docstrings from all symbols in the entire lisp image. -.RS -.RE .TP -.B \-\-delete\-package PKG +.B \[en]delete\-package PKG This option can be specified multiple times. -It uninterns the symbols in PACKAGE, calls \f[C]makeunbound\f[] and -\f[C]fmakeunbound\f[] on each symbol and deletes the package. -Package names are automatically string\-upcase\[aq]d. -.RS -.RE +It uninterns the symbols in PACKAGE, calls \f[C]makeunbound\f[R] and +\f[C]fmakeunbound\f[R] on each symbol and deletes the package. +Package names are automatically string\-upcase\[cq]d. .TP -.B \-\-delete\-all\-packages -This option applies \-\-delete\-package PKG on all packages, except some -blacklisted packages (keyword, roswell, ROS.SCRIPT.DUMP, and the package -of the main function symbol). -.RS -.RE +.B \[en]delete\-all\-packages +This option applies \[en]delete\-package PKG on all packages, except +some blacklisted packages (keyword, roswell, ROS.SCRIPT.DUMP, and the +package of the main function symbol). .TP -.B \-\-delete\-packages\-except PACKAGE +.B \[en]delete\-packages\-except PACKAGE This option can be specified multiple times. -It is identical to \-\-delete\-all\-packages except that it adds PACKAGE -to the blacklist. -Package names are automatically string\-upcase\[aq]d. -.RS -.RE +It is identical to \[en]delete\-all\-packages except that it adds +PACKAGE to the blacklist. +Package names are automatically string\-upcase\[cq]d. .TP -.B \-\-destroy\-packages\-sbcl +.B \[en]destroy\-packages\-sbcl This is an sbcl\-specific option which is even more aggressive than the above methods (>10MB reduction). It destroys the package system by modifying the internal tables for packages, cleaning up the caches for package\-use\-list etc. -The blacklist is shared among \-\-delete\-all\-packages and -\-\-destroy\-packages\-sbcl. +The blacklist is shared among \[en]delete\-all\-packages and +\[en]destroy\-packages\-sbcl. However, this method does not call fmakunbound/makunbound, so combining the two methods can result in a more aggressive image size reduction. Due to the nature of this option, it is desirable to specify it as the -last method (i.e. -rightmost). -.RS -.RE +last method (i.e.\ rightmost). .TP -.B \-\-purify, \-\-no\-purify +.B \[en]purify, \[en]no\-purify This is common to CCL, SBCL, CMUCL. Moves all objects to the static space where GC does not scan, for the later performance of GC. Purification is enabled by default. -.RS -.RE .TP -.B \-\-impurify, \-\-no\-impurify +.B \[en]impurify, \[en]no\-impurify This is an CCL\-specific option (enabled by default). It moves all objects to the dynamic space before saving the image. -This allows the static\-space objects to be GC\[aq]ed. +This allows the static\-space objects to be GC\[cq]ed. When purification is enabled, it impurifies all objects before running the purifying GC. -.RS -.RE .TP -.B \-\-delete\-debug\-info +.B \[en]delete\-debug\-info This removes the debug infomation of functions (used to show the stack frame etc), as well as the source locations and the deprecation information of various symbols. SBCL only. This option has a large effect (+10MB reduction). -.RS -.RE .TP -.B \-\-delete\-macro\-definitions, \-\-delete\-compiler\-macro\-definitions +.B \[en]delete\-macro\-definitions, \[en]delete\-compiler\-macro\-definitions This removes all definitions of macros and compiler\-macros, assuming that no runtime compilation/interpretation of code will be performed. This option should be portable across implementations. -It has ~2MB reduction on SBCL. -.RS -.RE +It has \[ti]2MB reduction on SBCL. .TP -.B \-\-delete\-compiler\-information\-sbcl +.B \[en]delete\-compiler\-information\-sbcl This is an SBCL\-specific option which is more aggressive than the above -methods (~4MB reduction). +methods (\[ti]4MB reduction). In addition to the macro and the compiler\-macro definitions, it destroys the internal compiler systems of SBCL by also removing the inlining information, IR1 transformer and IR2 (VOP). -.RS -.RE .SH SEE ALSO .PP -\f[I]sbcl\f[](1) \f[I]ros\f[](1) \f[I]ros\-init\f[](1) +\f[I]sbcl\f[R](1) \f[I]ros\f[R](1) \f[I]ros\-init\f[R](1) .SH AUTHORS Roswell Project Team. diff --git a/documents/man/ros-emacs.1 b/documents/man/ros-emacs.1 index 9826ac5..26ed1a7 100644 --- a/documents/man/ros-emacs.1 +++ b/documents/man/ros-emacs.1 @@ -1,11 +1,11 @@ -.\" Automatically generated by Pandoc 1.16.0.2 +.\" Automatically generated by Pandoc 2.5 .\" .TH "ros-emacs" "1" "" "" "" .hy .PP ros\-emacs \- launch Emacs with Slime # Synopsis .PP -\f[B]ros emacs\f[] [ARGS...] +\f[B]ros emacs\f[R] [ARGS\&...] .SH Description .PP Launches Emacs with a Slime(https://common\-lisp.net/project/slime/) @@ -14,6 +14,6 @@ of roswell. Additional arguments are passed to emacs. .SH SEE ALSO .PP -\f[I]ros\f[](1), \f[I]emacs\f[](1) +\f[I]ros\f[R](1), \f[I]emacs\f[R](1) .SH AUTHORS Roswell Project Team. diff --git a/documents/man/ros-help.1 b/documents/man/ros-help.1 index 6b42d9b..79c545e 100644 --- a/documents/man/ros-help.1 +++ b/documents/man/ros-help.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 1.16.0.2 +.\" Automatically generated by Pandoc 2.5 .\" .TH "ros-help" "1" "" "" "" .hy @@ -6,12 +6,12 @@ ros\-help \- Show Command help .SH Synopsis .PP -\f[B]ros help\f[] [subcommand or topics] +\f[B]ros help\f[R] [subcommand or topics] .SH Description .PP -\f[B]ros help\f[] shows description of subcommand or topics +\f[B]ros help\f[R] shows description of subcommand or topics .SH SEE ALSO .PP -\f[I]sbcl\f[](1), \f[I]ros\f[](1) +\f[I]sbcl\f[R](1), \f[I]ros\f[R](1) .SH AUTHORS Roswell Project Team. diff --git a/documents/man/ros-init.1 b/documents/man/ros-init.1 index 11bbd8d..a0df2a1 100644 --- a/documents/man/ros-init.1 +++ b/documents/man/ros-init.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 1.16.0.2 +.\" Automatically generated by Pandoc 2.5 .\" .TH "ros-init" "1" "" "" "" .hy @@ -6,16 +6,16 @@ ros\-init \- Create a roswell script (optionally based on a template) .SH Synopsis .PP -\f[B]ros init [TEMPLATE] NAME [ARGS...]]\f[] +\f[B]ros init [TEMPLATE] NAME [ARGS\&...]]\f[R] .TP .B TEMPLATE -Specifies the name of a template, defaulted to \f[I]default\f[] +Specifies the name of a template, defaulted to \f[I]default\f[R] template. -However, if \f[I]TEMPLATE\f[] is not specified and \f[I]FILENAME\f[] +However, if \f[I]TEMPLATE\f[R] is not specified and \f[I]FILENAME\f[R] 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[]. +\f[I]TEMPLATE\f[R] as \f[I]default\f[R]. .RS .PP Thus you are warned when you use this command from a shell script. @@ -24,47 +24,46 @@ 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 +Specify the output filename, or \[lq]\-\[rq] to indicate +\f[I]stdout\f[R]. +When \f[I]TEMPLATE\f[R] is \f[I]default\f[R], it automatically appends a +file type \[lq].ros\[rq]. .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[R](1). .PP The default template is something like: .IP .nf \f[C] #!/bin/sh -#|\-*\-\ mode:lisp\ \-*\-|# -#|\ -exec\ ros\ \-Q\ \-\-\ $0\ "$\@" +#|\-*\- mode:lisp \-*\-|# +#| +exec ros \-Q \-\- $0 \[dq]$\[at]\[dq] |# -(progn\ ;;init\ forms -\ \ (ros:ensure\-asdf) -\ \ ;;#+quicklisp\ (ql:quickload\ \[aq]()\ :silent\ t) -\ \ ) +(progn ;;init forms + (ros:ensure\-asdf) + ;;#+quicklisp (ql:quickload \[aq]() :silent t) + ) -(defpackage\ :ros.script.test.3703600390 -\ \ (:use\ :cl)) -(in\-package\ :ros.script.test.3703600390) +(defpackage :ros.script.test.3703600390 + (:use :cl)) +(in\-package :ros.script.test.3703600390) -(defun\ main\ (&rest\ argv) -\ \ (declare\ (ignorable\ argv))) -;;;\ vim:\ set\ ft=lisp\ lisp: -\f[] +(defun main (&rest argv) + (declare (ignorable argv))) +;;; vim: set ft=lisp lisp: +\f[R] .fi .PP This is basically a shell script which immediately invokes Roswell by -exec (see \f[I]sh(1)\f[]). +exec (see \f[I]sh(1)\f[R]). 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) \f[I]ros\-template\f[](1) +\f[I]sbcl\f[R](1) \f[I]ros\f[R](1) \f[I]ros\-template\f[R](1) .SH AUTHORS Roswell Project Team. diff --git a/documents/man/ros-install.1 b/documents/man/ros-install.1 index 7bbb2d5..728f82d 100644 --- a/documents/man/ros-install.1 +++ b/documents/man/ros-install.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 1.16.0.2 +.\" Automatically generated by Pandoc 2.5 .\" .TH "ros-install" "1" "" "" "" .hy @@ -6,82 +6,78 @@ ros\-install \- Install lisp implementations or quicklisp system .SH Synopsis .IP \[bu] 2 -\f[B]ros install\f[] system [system ...] +\f[B]ros install\f[R] system [system \&...] .IP \[bu] 2 -\f[B]ros install\f[] impl[/version] [param ...] +\f[B]ros install\f[R] impl[/version] [param \&...] .SH Description .TP .B system a name specifying a system. -.RS -.RE .TP .B impl a name specifying a lisp implementation. -.RS -.RE .SH Installing a Lisp Implementation .PP -When the \f[C]impl\f[] or \f[C]system\f[] matches to one of the +When the \f[C]impl\f[R] or \f[C]system\f[R] matches to one of the supported implementations, it fetches, downloads and installs it to one -of the internal directory managed by roswell (~/.roswell, or -\f[C]ROSWELL_INSTALL_DIR\f[]). +of the internal directory managed by roswell (\[ti]/.roswell, or +\f[C]ROSWELL_INSTALL_DIR\f[R]). In order to use the installed implementation, you have to run -\f[I]ros\-use(1)\f[]. +\f[I]ros\-use(1)\f[R]. .PP For example, the following command downloads the latest sbcl binary from sbcl.org. Note that this may be different from the default binary installed by -roswell, called \f[C]sbcl\-bin\f[]. -\f[C]sbcl\-bin\f[] is a stable and well\-tested version of the sbcl +roswell, called \f[C]sbcl\-bin\f[R]. +\f[C]sbcl\-bin\f[R] is a stable and well\-tested version of the sbcl binary which is supposed to be a little older than the latest sbcl. .IP .nf \f[C] -$\ ros\ install\ sbcl -\f[] +$ ros install sbcl +\f[R] .fi .PP When invoked without a name, it prints the list of installable implementations. -(Not to be confused with \f[C]ros\ list\ installed\f[], which shows the +(Not to be confused with \f[C]ros list installed\f[R], which shows the implementations already installed.) .IP .nf \f[C] -Usage:\ ros\ install\ impl\ [OPTIONS] +Usage: ros install impl [OPTIONS] -For\ more\ details\ on\ impl\ specific\ options,\ type: -ros\ help\ install\ impl +For more details on impl specific options, type: +ros help install impl -Candidates\ impls\ for\ installation\ are: +Candidates impls for installation are: ecl sbcl clisp ccl\-bin sbcl\-bin -\f[] +\f[R] .fi .PP -The name can be optionally followed by a slash \f[C]/\f[] and a version +The name can be optionally followed by a slash \f[C]/\f[R] and a version of the implementation. .IP .nf \f[C] -$\ ros\ install\ sbcl/1.2.14 -\f[] +$ ros install sbcl/1.2.14 +\f[R] .fi .PP -There might be some \f[I]hidden\f[] implementation that are not listed -here \-\-\- they are in the alpha quality, but try the one you like or +There might be some \f[I]hidden\f[R] implementation that are not listed +here \[em] they are in the alpha quality, but try the one you like or watch the website (https://github.com/roswell/roswell). .IP .nf \f[C] -$\ ros\ install\ ccl -$\ ros\ install\ abcl -$\ ... -\f[] +$ ros install ccl +$ ros install abcl +$ ... +\f[R] .fi .SH Installing a quicklisp system and the bundled roswell scripts .PP @@ -90,36 +86,36 @@ tries to find a quicklisp system of the given name. .IP .nf \f[C] -$\ ros\ install\ alexandria -\f[] +$ ros install alexandria +\f[R] .fi .PP After compiling and loading the system, it funcalls -\f[C]ros:*build\-hook*\f[] special variable with no argument, if some +\f[C]ros:*build\-hook*\f[R] special variable with no argument, if some function is set during the compilation/load. .PP -When the system comes with a \f[B]roswell script\f[] created by -\f[I]ros\-init\f[](1) in the subdirectory \f[C]roswell\f[], they are -installed into \f[B]ROSWELL_INSTALL_DIR/bin\f[]. +When the system comes with a \f[B]roswell script\f[R] created by +\f[I]ros\-init\f[R](1) in the subdirectory \f[C]roswell\f[R], they are +installed into \f[B]ROSWELL_INSTALL_DIR/bin\f[R]. Setting the path to this directory makes those scripts available from the shell command line. .IP .nf \f[C] -$\ ros\ install\ qlot -System\ \[aq]qlot\[aq]\ found.\ Loading\ the\ system.. -Processing\ build\-hook.. -Found\ 1\ scripts:\ qlot -Attempting\ to\ install\ the\ scripts\ in\ roswell/\ subdirectory\ of\ the\ system... +$ ros install qlot +System \[aq]qlot\[aq] found. Loading the system.. +Processing build\-hook.. +Found 1 scripts: qlot +Attempting to install the scripts in roswell/ subdirectory of the system... /home/user/.roswell/bin/qlot -$\ qlot -Usage:\ qlot\ [install\ |\ update\ |\ bundle\ |\ exec\ shell\-args..] -\f[] +$ qlot +Usage: qlot [install | update | bundle | exec shell\-args..] +\f[R] .fi .SH SEE ALSO .PP -\f[I]sbcl\f[](1), \f[I]ros\f[](1), \f[I]ros\-list\f[](1), -\f[I]ros\-init\f[](1) +\f[I]sbcl\f[R](1), \f[I]ros\f[R](1), \f[I]ros\-list\f[R](1), +\f[I]ros\-init\f[R](1) .SH AUTHORS Roswell Project Team. diff --git a/documents/man/ros-list.1 b/documents/man/ros-list.1 index 4eb32ff..ace0b3a 100644 --- a/documents/man/ros-list.1 +++ b/documents/man/ros-list.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 1.16.0.2 +.\" Automatically generated by Pandoc 2.5 .\" .TH "ros-list" "1" "" "" "" .hy @@ -6,35 +6,29 @@ ros\-list \- list the materials installed by roswell .SH Synopsis .PP -\f[B]ros list [type] [options]\f[] +\f[B]ros list [type] [options]\f[R] .SH Description .PP -\f[B]ros list\f[] shows the list of the materials installed by roswell. +\f[B]ros list\f[R] shows the list of the materials installed by roswell. .TP -.B installed [ [ IMPL | IMPL/VERSION ]...] +.B installed [ [ IMPL | IMPL/VERSION ]\&...] List the implementations that have been already installed. Optionally providing IMPL shows the installed versions of the implementation. -.RS -.RE .TP .B dump [IMPL] List the internal dumped images that are compatible with IMPL. When IMPL is ommited, it is defaulted to the current lisp implementation in use. -Images are in \f[C]$ROSWELL_INSTALL_DIR/impl/.../dump/\f[]. -.RS -.RE +Images are in \f[C]$ROSWELL_INSTALL_DIR/impl/.../dump/\f[R]. .TP .B versions [IMPL] List the installable versions for IMPL. When IMPL is ommited, it is defaulted to the current lisp implementation in use. This feature is experimental. -.RS -.RE .SH SEE ALSO .PP -\f[I]sbcl\f[](1) \f[I]ros\f[](1) +\f[I]sbcl\f[R](1) \f[I]ros\f[R](1) .SH AUTHORS Roswell Project Team. diff --git a/documents/man/ros-run.1 b/documents/man/ros-run.1 index 002b73d..f6cebdb 100644 --- a/documents/man/ros-run.1 +++ b/documents/man/ros-run.1 @@ -1,17 +1,17 @@ -.\" Automatically generated by Pandoc 1.16.0.2 +.\" Automatically generated by Pandoc 2.5 .\" .TH "ros-run" "1" "" "" "" .hy .PP ros\-run \- start a REPL # Synopsis .PP -\f[B]ros [options] run\f[] +\f[B]ros [options] run\f[R] .SH Description .PP Processes the given options and start a REPL using the currently -effective lisp implementation set by \f[I]ros\-use\f[](1). +effective lisp implementation set by \f[I]ros\-use\f[R](1). .SH SEE ALSO .PP -\f[I]ros\f[](1) +\f[I]ros\f[R](1) .SH AUTHORS Roswell Project Team. diff --git a/documents/man/ros-serve.1 b/documents/man/ros-serve.1 index 22ca86f..15618b9 100644 --- a/documents/man/ros-serve.1 +++ b/documents/man/ros-serve.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 1.16.0.2 +.\" Automatically generated by Pandoc 2.5 .\" .TH "ros-serve" "1" "" "" "" .hy @@ -6,26 +6,22 @@ ros\-serve \- start lisp server .SH Synopsis .PP -\f[B]ros [options for roswell ... ] serve\f[] protocol [options for the -protocol ...] ... +\f[B]ros [options for roswell \&... ] serve\f[R] protocol [options for +the protocol \&...] \&... .SH description .PP -\f[C]ros\-serve\f[] start lisp and wait for clients to connect to the +\f[C]ros\-serve\f[R] start lisp and wait for clients to connect to the lisp. .SH swank protocol options .TP -.B \f[C]\-\-port\ port\f[] -Listen port would be \f[C]port\f[] instead of the default port 4005. -.RS -.RE +.B \f[C]\-\-port port\f[R] +Listen port would be \f[C]port\f[R] instead of the default port 4005. .TP -.B \f[C]\-\-interface\ interface\f[] +.B \f[C]\-\-interface interface\f[R] limit interface for listen. -default is \f[C]localhost\f[] so there would be no limitation. -.RS -.RE +default is \f[C]localhost\f[R] so there would be no limitation. .SH SEE ALSO .PP -\f[I]ros\f[](1) \f[I]ros\-client\f[](1) +\f[I]ros\f[R](1) \f[I]ros\-client\f[R](1) .SH AUTHORS Roswell Project Team. diff --git a/documents/man/ros-setup.1 b/documents/man/ros-setup.1 index 78fffd7..40b8e14 100644 --- a/documents/man/ros-setup.1 +++ b/documents/man/ros-setup.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 1.16.0.2 +.\" Automatically generated by Pandoc 2.5 .\" .TH "ros-setup" "1" "" "" "" .hy @@ -6,22 +6,22 @@ ros\-setup \- setup the backend of roswell .SH Synopsis .PP -\f[B]ros setup\f[] +\f[B]ros setup\f[R] .SH Description .PP -\f[B]ros setup\f[] initializes roswell. +\f[B]ros setup\f[R] initializes roswell. The process includes the following steps: .IP \[bu] 2 Downloading the default stable lisp implementation (sbcl\-bin) to -\f[C]ROSWELL_INSTALL_DIR\f[]. +\f[C]ROSWELL_INSTALL_DIR\f[R]. .IP \[bu] 2 -Installing quicklisp to \f[C]ROSWELL_INSTALL_DIR\f[]. +Installing quicklisp to \f[C]ROSWELL_INSTALL_DIR\f[R]. .IP \[bu] 2 -On Windows, install 7zip to \f[C]ROSWELL_INSTALL_DIR\f[]. +On Windows, install 7zip to \f[C]ROSWELL_INSTALL_DIR\f[R]. .IP \[bu] 2 Making the core image of roswell itself. .SH SEE ALSO .PP -\f[I]sbcl\f[](1), \f[I]ros\f[](1), section Environmental Variables +\f[I]sbcl\f[R](1), \f[I]ros\f[R](1), section Environmental Variables .SH AUTHORS Roswell Project Team. diff --git a/documents/man/ros-template.1 b/documents/man/ros-template.1 index c330c5b..cff672a 100644 --- a/documents/man/ros-template.1 +++ b/documents/man/ros-template.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 1.16.0.2 +.\" Automatically generated by Pandoc 2.5 .\" .TH "ros-template" "1" "" "" "" .hy @@ -6,253 +6,223 @@ ros\-template \- Edit template for ros\-init .SH synopsis .IP \[bu] 2 -\f[B]ros template\f[] command args... +\f[B]ros template\f[R] command args\&... .SH Subcommands .TP .B init template\-name Create new template in local\-project directory. -.RS -.RE .TP .B deinit template\-name Remove a template from local\-project directory. -.RS -.RE .TP .B list -Show file list and states of the files \f[I]type\f[] \f[I]chmod\f[] -\f[I]rewrite\f[] in templates. -.RS -.RE +Show file list and states of the files \f[I]type\f[R] \f[I]chmod\f[R] +\f[I]rewrite\f[R] in templates. .TP .B checkout [template\-name] When invoked without template\-name,this command shows candidates for current templates to operate.If with template\-name, this command choose the name as current template. -.RS -.RE .TP -.B add [template\-name] [files ...] +.B add [template\-name] [files \&...] Add files to current template.First parameter could taken as a -template\-name when current template are \f[I]default\f[]. -.RS -.RE +template\-name when current template are \f[I]default\f[R]. .TP -.B cat [template\-name] [files ...] +.B cat [template\-name] [files \&...] Show contents in the current template. -.RS -.RE .TP -.B edit [template\-name] [files ...] -Edit content of files in template using \f[C]/usr/bin/editor\f[]. -.RS -.RE +.B edit [template\-name] [files \&...] +Edit content of files in template using \f[C]/usr/bin/editor\f[R]. .TP -.B path [template\-name] [files ...] +.B path [template\-name] [files \&...] Show native path of files in template. -.RS -.RE .TP -.B rm [template\-name] [files ...] +.B rm [template\-name] [files \&...] Remove file form current template. -.RS -.RE .TP -.B type [template\-name] [type] [files ...] +.B type [template\-name] [type] [files \&...] Change file type. -current choice for \f[I]type\f[]s are \f[I]djula\f[] or \f[I]copy\f[] +current choice for \f[I]type\f[R]s are \f[I]djula\f[R] or \f[I]copy\f[R] {{name}} {{author}} {{email}} {{universal_time}} are available variable in the template file. Withoug files, change default type. -.RS -.RE .TP -.B chmod [template\-name] [mode] [files ...] +.B chmod [template\-name] [mode] [files \&...] Change file mode bits to generate. specify mode in octal format. -.RS -.RE .TP .B rewrite [template\-name] file rewrite\-rule Change file name using djula template.Variables {{name}} {{author}} {{email}} {{universal_time}} are available for rewrite\-rule. -.RS -.RE .TP .B export [template\-name] [directory] Export files in current template to current directory. -.RS -.RE .TP .B import [directory] Import template in current directory -.RS -.RE .TP .B help Show the subcommand help. -.RS -.RE .SH Description .PP -The \f[I]ros\-template\f[](1) command manages templates of projects. +The \f[I]ros\-template\f[R](1) command manages templates of projects. .SS Create template .PP -First, the \f[C]init\f[] sub\-command creates an empty template. +First, the \f[C]init\f[R] sub\-command creates an empty template. .IP .nf \f[C] -$\ ros\ template\ init\ sample\-template -\f[] +$ ros template init sample\-template +\f[R] .fi .PP Many of sub\-commands take a template name as first argument. -But you can omit it by the \f[C]checkout\f[] sub\-commands. +But you can omit it by the \f[C]checkout\f[R] sub\-commands. After the following, such sub\-commands are applied to -\f[C]sample\-template\f[]. +\f[C]sample\-template\f[R]. .IP .nf \f[C] -$\ ros\ template\ checkout\ sample\-template -\f[] +$ ros template checkout sample\-template +\f[R] .fi .PP -Next, the \f[C]add\f[] sub\-command adds local file[s] to template. -Then, the \f[C]list\f[] sub\-command shows information of files in +Next, the \f[C]add\f[R] sub\-command adds local file[s] to template. +Then, the \f[C]list\f[R] sub\-command shows information of files in template. .IP .nf \f[C] -$\ echo\ "Hello\ {{\ author\ }}!!"\ >\ sample.txt -$\ ros\ template\ add\ sample.txt -$\ ros\ template\ list -\ \ \ \ \ \ copy\ \ sample.txt\ -\f[] +$ echo \[dq]Hello {{ author }}!!\[dq] > sample.txt +$ ros template add sample.txt +$ ros template list + copy sample.txt +\f[R] .fi .PP -The word \f[I]copy\f[] means a strategy when applying the template. +The word \f[I]copy\f[R] means a strategy when applying the template. There are the following 2 strategies. .IP \[bu] 2 -\f[I]copy\f[] simply copies the file as\-is. +\f[I]copy\f[R] simply copies the file as\-is. .IP \[bu] 2 -\f[I]djula\f[] processes the content of the file by template engine, +\f[I]djula\f[R] processes the content of the file by template engine, Djula (http://mmontone.github.io/djula/). .RS 2 .IP \[bu] 2 Available variables are explained later. .RE .PP -The \f[C]type\f[] sub\-command changes it. -In addition, default strategy (\f[I]copy\f[]) can be changed for each -template by the \f[C]type\f[] sub\-command without file names (Ex. -\f[C]ros\ template\ type\ djula\f[]). +The \f[C]type\f[R] sub\-command changes it. +In addition, default strategy (\f[I]copy\f[R]) can be changed for each +template by the \f[C]type\f[R] sub\-command without file names (Ex. +\f[C]ros template type djula\f[R]). .IP .nf \f[C] -$\ ros\ template\ type\ djula\ sample.txt -$\ ros\ template\ list -\ \ \ \ \ \ djula\ sample.txt\ -\f[] +$ ros template type djula sample.txt +$ ros template list + djula sample.txt +\f[R] .fi .PP -The \f[C]sample.txt\f[] will be simply output as \f[C]sample.txt\f[] in -default. -But you can change it by the \f[C]rewrite\f[] sub\-command. +The \f[C]sample.txt\f[R] will be simply output as \f[C]sample.txt\f[R] +in default. +But you can change it by the \f[C]rewrite\f[R] sub\-command. In the following example, it will be output as -\f[C]sample_.txt\f[]. +\f[C]sample_.txt\f[R]. .IP .nf \f[C] -$\ ros\ template\ rewrite\ sample.txt\ "sample\-{{\ name\ }}.txt" -$\ ros\ template\ list -\ \ \ \ \ \ djula\ sample.txt\ \->\ "sample\-{{\ name\ }}.txt" -\f[] +$ ros template rewrite sample.txt \[dq]sample\-{{ name }}.txt\[dq] +$ ros template list + djula sample.txt \-> \[dq]sample\-{{ name }}.txt\[dq] +\f[R] .fi .PP Note: Rewrite rules are always processed by Djula irrespective of strategy of the file. .SS Apply template .PP -\f[I]ros\-init\f[](1) can specify a template. +\f[I]ros\-init\f[R](1) can specify a template. .IP .nf \f[C] -$\ mkdir\ temp\ ;\ cd\ temp -$\ ros\ init\ sample\-template\ some\-project -$\ ls +$ mkdir temp ; cd temp +$ ros init sample\-template some\-project +$ ls sample\-some\-project.txt -$\ cat\ sample\-some\-project.txt\ #\ Assume\ that\ "author"\ is\ "alien" -Hello\ alien!! -\f[] +$ cat sample\-some\-project.txt # Assume that \[dq]author\[dq] is \[dq]alien\[dq] +Hello alien!! +\f[R] .fi .PP The file name and its content are processed by Djula as explained in the above. The following variables can be used in defaut. .IP \[bu] 2 -{{name}}: A project name specified in \f[I]ros\-init\f[](1) +{{name}}: A project name specified in \f[I]ros\-init\f[R](1) .IP \[bu] 2 {{author}}: An author name extracted from config of Git or -\f[C]whoami\f[] +\f[C]whoami\f[R] .IP \[bu] 2 {{email}}: An e\-mail address extracted from config of Git or created -using \f[C]whoami\f[] and \f[C]hostname\f[] +using \f[C]whoami\f[R] and \f[C]hostname\f[R] .IP \[bu] 2 {{universal_time}}: A universal time created by -\f[C]get\-universal\-time\f[] function +\f[C]get\-universal\-time\f[R] function .PP In addition, you can use original variables as the followings. .IP .nf \f[C] -$\ echo\ "Hello\ {{\ area\ }}!!"\ >\ sample.txt -$\ ros\ template\ add\ sample.txt\ #\ Note:\ It\ overwrites\ existing -$\ mkdir\ temp\ ;\ cd\ temp -$\ ros\ init\ sample\-template\ roswell\ \-\-area\ 51 -$\ cat\ sample\-roswell.txt -Hello\ 51!! -\f[] +$ echo \[dq]Hello {{ area }}!!\[dq] > sample.txt +$ ros template add sample.txt # Note: It overwrites existing +$ mkdir temp ; cd temp +$ ros init sample\-template roswell \-\-area 51 +$ cat sample\-roswell.txt +Hello 51!! +\f[R] .fi .SS Export and import template .PP -Basically, \f[I]ros\-template\f[](1) is designed to internally manage +Basically, \f[I]ros\-template\f[R](1) is designed to internally manage added files. .PP However, if you want to, for example, manage it using Git in a local directory or to install distributed templates, you can use the -\f[C]export\f[] and \f[C]import\f[] sub\-commands. +\f[C]export\f[R] and \f[C]import\f[R] sub\-commands. .PP -First, the \f[C]export\f[] sub\-command exports added files and a -setting file \f[C]roswell.init..asd\f[] that is +First, the \f[C]export\f[R] sub\-command exports added files and a +setting file \f[C]roswell.init.