Common Lisp port of Ruby's shellwords.rb, for escaping and
splitting strings to be passed to a shell.

cl-shellwords

# cl-shellwords

[![Build Status](https://travis-ci.org/jorams/cl-shellwords.svg)](https://travis-ci.org/jorams/cl-shellwords)
[![Quicklisp](http://quickdocs.org/badge/cl-shellwords.svg)](http://quickdocs.org/cl-shellwords/)

CL-shellwords is a port of Ruby's shellwords.rb to Common Lisp. It can be used to escape strings for use on the (Bourne) shell, or to split command lines into segments according to the shell's escaping rules.

## Dependencies

CL-shellwords depends only on [CL-PPCRE](http://weitz.de/cl-ppcre/) (BSD). The tests additionally depend on [Prove](https://github.com/fukamachi/prove) (MIT).

## Documentation

CL-shellwords defines the package `:cl-shellwords`, with the alias `:shellwords`. This package exports three functions, a condition and an accessor for that condition.

### SPLIT

```lisp
(split string)
```

Split `STRING` into a list of words, handling escaping the same way a shell like the Bourne shell does.

Whitespace normally acts as a word separator, except when preceded by a backslash or enclosed in single- or double quotes.

```lisp
Examples:
(split "example string")
;=> ("example"  "string")
(split "example\ escaped string")
;=> ("example escaped" "string")
(split "example 'escaped string'")
;=> ("example" "escaped string")
(split "example "escaped string"")
;=> ("example" "escaped string")
```

If `STRING` contains non-matching single- or double quotes, an error of type `UNMATCHED-QUOTE-ERROR` is signaled. `STRING` can be retrieved from the error object using `UNMATCHED-QUOTE-ERROR-STRING`.

### ESCAPE

```lisp
(escape string)
```

 Escape `STRING` so that it is safe when used as an argument in a shell like
the Bourne shell.

- If `STRING` is an empty string, a pair of single quotes is returned.
- An LF character is escaped by placing it in single quotes.
- All other special characters are escaped with a backslash.

Examples:
```lisp
(escape "")
;=> "''"
(escape "It's an example string")
;=> "It\s\ an\ example\ string"
(escape "NothingWrongHere")
;=> "NothingWrongHere"
(escape "{LF}")
;=> "'{LF}'" ({LF} = #\linefeed)
```

### JOIN

```lisp
(join sequence)
```
Join the elements of `SEQUENCE` together, separated by spaces. The elements are first passed to `ESCAPE` for proper escaping.

`SEQUENCE` should be a list or vector of strings.

## License

    Copyright (c) 2015 Joram Schrijver

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.


cl-shellwords

Upstream URL

Author

License

cl-shellwords

Version:

License:

Authors:

Dependencies:

cl-shellwords-test

License:

Authors:

Dependencies:

Dependencies (2)

Dependents (0)