The ufo Reference Manual

This is the ufo Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 07:13:57 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 ufo

Roswell Script Manager

Author

Masaya TANIGUCHI

License

MIT

Long Description

# UFO
[![Build Status](https://travis-ci.org/ta2gch/UFO.svg?branch=master)](https://travis-ci.org/ta2gch/UFO)
[![Coverage Status](https://coveralls.io/repos/ta2gch/UFO/badge.svg?branch=master)](https://coveralls.io/r/ta2gch/UFO)

This project was DEPRECATED. You can use ‘ros install <Github Repo>/<Project>‘.

Thanks for your stars. :smile:

## Description
**UFO** is a Roswell script manager.

you can install following utilities via **UFO**.
- [chls.ros](https://gist.github.com/fukamachi/3510ea1609c1b52830c2) – opening HyperSpec page describing a given symbol in the default browser. - [lem.ros](https://gist.github.com/peccu/b1db8bf3f26d0b7c31d1) – launch lem from shell.
- etc ...

## Features
### Easy to Install and Execute.
You can install Roswell Script on internet,
as easy as Quicklisp.
“‘
$ ufo install https://example.com/test.ros # Only this!
“‘

### Schemes Extension
UFO has mercurial style _schemes extension_.

‘gist://example.com/sample.com‘ , ‘file:///path/to/roswell/script/test.ros‘,etc ...

Of course, you can use ‘http://‘ and ‘https://‘.

### Addons
UFO have a self enhancement system, _addons_.

If you want to make _addons_ of UFO,
UFO requires to make with Roswell Script.

UFO has some preinstall Addons.

#### Manage CommonLisp Project on Github
schemes is ‘gh://‘.
and you can use ‘install‘ and ‘update‘ ,‘remove‘ sub commands.

“‘
$ ufo install gh://ta2gch/cl-pov
$ ufo update gh://ta2gch/cl-pov
$ ufo remove cl-pov
“‘

#### Generate Roswell Script
subcommand is ‘init‘.

- ‘ufo init <file-name>‘ generate temprate of Roswell Script

## Usage

UFO has ‘apt‘ style sub commands,

‘install <package-url>‘ and ‘remove <package-name>‘ ,‘update <package-url>‘
### Install

“‘
$ ufo install <package-url>
$ ufo install https://example.com/sample.ros
$ ufo install gist://ta2gch/repl.ros
$ ufo install file://~/hello.ros
“‘
### Uninstall

“‘
$ ufo remove <package-name>
$ ufo remove repl
$ ufo remove hello
“‘

### Update
“‘
$ ufo update <package-url>
$ ufo update gist://ta2gch/repl.ros
$ ufo update file://~/hello.ros
“‘

## Installation

“‘shell
$ cd ~/common-lisp
$ git clone git://github.com/ta2gch/UFO
$ cd UFO && ros -l ufo.asd install ufo
“‘
*ensure that ‘~/.roswell/bin‘ is in the system’s search path.*

## Requirements

* [Roswell](https://github.com/snmsts/roswell)

## Author

* Masaya TANIGUCHI (ta2gch@gmail.com)

## License

GPLv3

## Copyright

Copyright (c) 2015 Masaya TANIGUCHI (ta2gch@gmail.com)

Version

0.1

Dependency

uiop (system).

Source

ufo.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 ufo/src

Source

ufo.asd.

Parent Component

ufo (system).

Child Components

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


4.1 Lisp


4.1.1 ufo/ufo.asd

Source

ufo.asd.

Parent Component

ufo (system).

ASDF Systems

ufo.

Packages

ufo-asd.


4.1.2 ufo/src/ufo.lisp

Dependencies
Source

ufo.asd.

Parent Component

src (module).

Packages

ufo.

Public Interface
Internals

subcmd-p (function).


4.1.3 ufo/src/addon.lisp

Dependency

util.lisp (file).

Source

ufo.asd.

Parent Component

src (module).

Packages

ufo.addon.

Public Interface

addon (function).


4.1.4 ufo/src/util.lisp

Source

ufo.asd.

Parent Component

src (module).

Packages

ufo.util.

Public Interface

5 Packages

Packages are listed by definition order.


5.1 ufo.addon

Source

addon.lisp.

Use List
Used By List

ufo.

Public Interface

addon (function).


5.2 ufo

Source

ufo.lisp.

Use List
Public Interface
Internals

subcmd-p (function).


5.3 ufo-asd

Source

ufo.asd.

Use List
  • asdf/interface.
  • common-lisp.

5.4 ufo.util

Source

util.lisp.

Use List

common-lisp.

Used By List
Public Interface

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


6.1 Public Interface


6.1.1 Ordinary functions

Function: addon (&rest argv)
Package

ufo.addon.

Source

addon.lisp.

Function: dot-roswell (path)
Package

ufo.util.

Source

util.lisp.

Function: dot-ufo (path)
Package

ufo.util.

Source

util.lisp.

Function: setup ()
Package

ufo.

Source

ufo.lisp.

Function: ufo (subcmd &rest argv)
Package

ufo.

Source

ufo.lisp.


6.2 Internals


6.2.1 Ordinary functions

Function: subcmd-p (subcmd)
Package

ufo.

Source

ufo.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables