Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-shellwords Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:48:02 2020 GMT+0.
| • Introduction | What cl-shellwords is all about | |
| • Systems | The systems documentation | |
| • Files | The files documentation | |
| • Packages | The packages documentation | |
| • Definitions | The symbols documentation | |
| • Indexes | Concepts, functions, variables and data types |
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.
CL-shellwords depends only on CL-PPCRE (BSD). The tests additionally depend on Prove (MIT).
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 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.
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 string)
Escape STRING so that it is safe when used as an argument in a shell like
the Bourne shell.
STRING is an empty string, a pair of single quotes is returned.Examples:
(escape "")
;=> "''"
(escape "It's an example string")
;=> "It\s\ an\ example\ string"
(escape "NothingWrongHere")
;=> "NothingWrongHere"
(escape "{LF}")
;=> "'{LF}'" ({LF} = #\linefeed)
(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.
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.
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The cl-shellwords system |
Joram Schrijver <i@joram.io>
MIT
Common Lisp port of Ruby’s shellwords.rb, for escaping and splitting strings to be passed to a shell.
0.1
cl-ppcre
cl-shellwords.asd (file)
shellwords.lisp (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files |
| • The cl-shellwords.asd file | ||
| • The cl-shellwords/shellwords.lisp file |
Next: The cl-shellwords/shellwords․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-shellwords.asd
cl-shellwords (system)
Previous: The cl-shellwords․asd file, Up: Lisp files [Contents][Index]
cl-shellwords (system)
shellwords.lisp
+split-regexp+ (special variable)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The cl-shellwords package |
shellwords.lisp (file)
shellwords
common-lisp
+split-regexp+ (special variable)
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions | ||
| • Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported functions | ||
| • Exported generic functions | ||
| • Exported conditions |
Next: Exported generic functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
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:
(escape "") ;=> "”"
(escape "It’s an example string") ;=> "It\s\ an\ example\ string"
(escape "NothingWrongHere") ;=> "NothingWrongHere"
(escape "{LF}") ;=> "’{LF}’" ({LF} = #\linefeed)
shellwords.lisp (file)
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.
shellwords.lisp (file)
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.
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.
shellwords.lisp (file)
Next: Exported conditions, Previous: Exported functions, Up: Exported definitions [Contents][Index]
shellwords.lisp (file)
Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
shellwords.lisp (file)
simple-error (condition)
unmatched-quote-error-string (method)
:string
unmatched-quote-error-string (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal special variables |
Previous: Internal definitions, Up: Internal definitions [Contents][Index]
shellwords.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index | ||
| • Function index | ||
| • Variable index | ||
| • Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | C F L |
|---|
| Jump to: | C F L |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | E F G J M S U |
|---|
| Jump to: | E F G J M S U |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | +
S |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| + | |||
+split-regexp+: | Internal special variables | ||
| | |||
| S | |||
Slot, string: | Exported conditions | ||
Special Variable, +split-regexp+: | Internal special variables | ||
string: | Exported conditions | ||
| | |||
| Jump to: | +
S |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | C P S U |
|---|
| Jump to: | C P S U |
|---|