The trivial-raw-io Reference Manual

Table of Contents

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

The trivial-raw-io Reference Manual

This is the trivial-raw-io Reference Manual, version 0.0.2, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:27:31 2018 GMT+0.


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

1 Introduction

trivial-raw-io

For all your portable CL raw POSIX I/O needs! We export three simple symbols: with-raw-io, read-char, and read-line.

Obviously, read-char and read-line shadow the existing CL symbols. We simply call them inside with-raw-io.

with-raw-io is a macro which takes a &body and executes BODY with IO in non-canonical mode by modifying POSIX termios settings, then restores the previous settings.

At this time, trivial-raw-io has been tested on: SBCL, CCL, CMUCL, and CLISP. All testing has been done on Linux.


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 trivial-raw-io

Maintainer

Brit Butler <redline6561@gmail.com>

Author

Brit Butler <redline6561@gmail.com>

License

BSD

Description

Helpers for doing raw POSIX I/O

Version

0.0.2

Dependencies
Source

trivial-raw-io.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 trivial-raw-io/src

Parent

trivial-raw-io (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 trivial-raw-io.asd

Location

trivial-raw-io.asd

Systems

trivial-raw-io (system)


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

4.1.2 trivial-raw-io/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

trivial-raw-io


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

4.1.3 trivial-raw-io/src/raw-io.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/raw-io.lisp

Exported Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 trivial-raw-io

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

6.1.1 Macros

Macro: with-raw-io (&key VMIN VTIME) &body BODY

Execute BODY without echoing input IO actions.

Package

trivial-raw-io

Source

raw-io.lisp (file)


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

6.1.2 Functions

Function: read-char &optional STREAM EOF-ERROR-P EOF-VALUE RECURSIVE-P

Read a single character without echoing it from stream STREAM.

Package

trivial-raw-io

Source

raw-io.lisp (file)

Function: read-line &optional STREAM EOF-ERROR-P EOF-VALUE RECURSIVE-P

Read a line without echoing it from stream STREAM.

Package

trivial-raw-io

Source

raw-io.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M   T  
Index Entry  Section

F
File, Lisp, trivial-raw-io.asd: The trivial-raw-io<dot>asd file
File, Lisp, trivial-raw-io/src/packages.lisp: The trivial-raw-io/src/packages<dot>lisp file
File, Lisp, trivial-raw-io/src/raw-io.lisp: The trivial-raw-io/src/raw-io<dot>lisp file

L
Lisp File, trivial-raw-io.asd: The trivial-raw-io<dot>asd file
Lisp File, trivial-raw-io/src/packages.lisp: The trivial-raw-io/src/packages<dot>lisp file
Lisp File, trivial-raw-io/src/raw-io.lisp: The trivial-raw-io/src/raw-io<dot>lisp file

M
Module, trivial-raw-io/src: The trivial-raw-io/src module

T
trivial-raw-io.asd: The trivial-raw-io<dot>asd file
trivial-raw-io/src: The trivial-raw-io/src module
trivial-raw-io/src/packages.lisp: The trivial-raw-io/src/packages<dot>lisp file
trivial-raw-io/src/raw-io.lisp: The trivial-raw-io/src/raw-io<dot>lisp file

Jump to:   F   L   M   T  

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

A.2 Functions

Jump to:   F   M   R   W  
Index Entry  Section

F
Function, read-char: Exported functions
Function, read-line: Exported functions

M
Macro, with-raw-io: Exported macros

R
read-char: Exported functions
read-line: Exported functions

W
with-raw-io: Exported macros

Jump to:   F   M   R   W  

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

A.3 Variables


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

A.4 Data types

Jump to:   P   S   T  
Index Entry  Section

P
Package, trivial-raw-io: The trivial-raw-io package

S
System, trivial-raw-io: The trivial-raw-io system

T
trivial-raw-io: The trivial-raw-io system
trivial-raw-io: The trivial-raw-io package

Jump to:   P   S   T