The ufo Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The ufo Reference Manual

This is the ufo Reference Manual, version 0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:43:33 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

UFO

Build Status Coverage Status

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.

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 ...

Off cause, 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.

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

$ 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

Why 'UFO'

LISP Aliens fly in a UFO. :smile:

Author

License

GPLv3

Copyright

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


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 ufo

Author

Masaya TANIGUCHI

License

MIT

Description

Roswell Script Manager

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 ...

Off cause, 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)

## Why ’UFO’
LISP Aliens fly in a UFO. :smile:

## Author

* Masaya TANIGUCHI (ta2gch@gmail.com)

## License

GPLv3

## Copyright

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

Version

0.1

Dependency

uiop

Source

ufo.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


Previous: , Up: Modules   [Contents][Index]

3.1 ufo/src

Parent

ufo (system)

Location

src/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 ufo.asd

Location

ufo.asd

Systems

ufo (system)

Packages

ufo-asd


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 ufo/src/ufo.lisp

Dependencies
Parent

src (module)

Location

src/ufo.lisp

Packages

ufo

Exported Definitions
Internal Definitions

subcmd-p (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 ufo/src/addon.lisp

Dependency

util.lisp (file)

Parent

src (module)

Location

src/addon.lisp

Packages

ufo.addon

Exported Definitions

addon (function)


Previous: , Up: Lisp files   [Contents][Index]

4.1.4 ufo/src/util.lisp

Parent

src (module)

Location

src/util.lisp

Packages

ufo.util

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 ufo-asd

Source

ufo.asd

Use List

Next: , Previous: , Up: Packages   [Contents][Index]

5.2 ufo

Source

ufo.lisp (file)

Use List
Exported Definitions
Internal Definitions

subcmd-p (function)


Next: , Previous: , Up: Packages   [Contents][Index]

5.3 ufo.addon

Source

addon.lisp (file)

Use List
Used By List

ufo

Exported Definitions

addon (function)


Previous: , Up: Packages   [Contents][Index]

5.4 ufo.util

Source

util.lisp (file)

Use List

common-lisp

Used By List
Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Functions

Function: addon &rest ARGV
Package

ufo.addon

Source

addon.lisp (file)

Function: dot-roswell PATH
Package

ufo.util

Source

util.lisp (file)

Function: dot-ufo PATH
Package

ufo.util

Source

util.lisp (file)

Function: setup ()
Package

ufo

Source

ufo.lisp (file)

Function: ufo SUBCMD &rest ARGV
Package

ufo

Source

ufo.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Functions

Function: subcmd-p SUBCMD
Package

ufo

Source

ufo.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   M   U  
Index Entry  Section

F
File, Lisp, ufo.asd: The ufo<dot>asd file
File, Lisp, ufo/src/addon.lisp: The ufo/src/addon<dot>lisp file
File, Lisp, ufo/src/ufo.lisp: The ufo/src/ufo<dot>lisp file
File, Lisp, ufo/src/util.lisp: The ufo/src/util<dot>lisp file

L
Lisp File, ufo.asd: The ufo<dot>asd file
Lisp File, ufo/src/addon.lisp: The ufo/src/addon<dot>lisp file
Lisp File, ufo/src/ufo.lisp: The ufo/src/ufo<dot>lisp file
Lisp File, ufo/src/util.lisp: The ufo/src/util<dot>lisp file

M
Module, ufo/src: The ufo/src module

U
ufo.asd: The ufo<dot>asd file
ufo/src: The ufo/src module
ufo/src/addon.lisp: The ufo/src/addon<dot>lisp file
ufo/src/ufo.lisp: The ufo/src/ufo<dot>lisp file
ufo/src/util.lisp: The ufo/src/util<dot>lisp file

Jump to:   F   L   M   U  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   D   F   S   U  
Index Entry  Section

A
addon: Exported functions

D
dot-roswell: Exported functions
dot-ufo: Exported functions

F
Function, addon: Exported functions
Function, dot-roswell: Exported functions
Function, dot-ufo: Exported functions
Function, setup: Exported functions
Function, subcmd-p: Internal functions
Function, ufo: Exported functions

S
setup: Exported functions
subcmd-p: Internal functions

U
ufo: Exported functions

Jump to:   A   D   F   S   U  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables


Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   P   S   U  
Index Entry  Section

P
Package, ufo: The ufo package
Package, ufo-asd: The ufo-asd package
Package, ufo.addon: The ufo<dot>addon package
Package, ufo.util: The ufo<dot>util package

S
System, ufo: The ufo system

U
ufo: The ufo system
ufo: The ufo package
ufo-asd: The ufo-asd package
ufo.addon: The ufo<dot>addon package
ufo.util: The ufo<dot>util package

Jump to:   P   S   U