• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..--

examples/23-Nov-2023-107

src/23-Nov-2023-211144

.cargo_vcs_info.jsonD23-Nov-202374 65

.gitignoreD23-Nov-202323 43

Android.bpD23-Nov-2023761 3429

CHANGELOG.mdD23-Nov-20231.6 KiB7438

Cargo.tomlD23-Nov-20231.3 KiB3533

Cargo.toml.origD23-Nov-2023766 2721

LICENSED23-Nov-20231 KiB2117

METADATAD23-Nov-2023363 2019

MODULE_LICENSE_MITD23-Nov-20230

OWNERSD23-Nov-202340 21

README.mdD23-Nov-20231.7 KiB7552

rustfmt.tomlD23-Nov-2023215 44

README.md

1# atty
2
3[![Build Status](https://travis-ci.org/softprops/atty.svg?branch=master)](https://travis-ci.org/softprops/atty) [![Build status](https://ci.appveyor.com/api/projects/status/geggrsnsjsuse8cv?svg=true)](https://ci.appveyor.com/project/softprops/atty) [![Coverage Status](https://coveralls.io/repos/softprops/atty/badge.svg?branch=master&service=github)](https://coveralls.io/github/softprops/atty?branch=master) [![crates.io](https://img.shields.io/crates/v/atty.svg)](https://crates.io/crates/atty) [![Released API docs](https://docs.rs/atty/badge.svg)](http://docs.rs/atty) [![Master API docs](https://img.shields.io/badge/docs-master-green.svg)](https://softprops.github.io/atty)
4
5> are you or are you not a tty?
6
7
8## install
9
10Add the following to your `Cargo.toml`
11
12```toml
13[dependencies]
14atty = "0.2"
15```
16
17## usage
18
19```rust
20use atty::Stream;
21
22fn main() {
23  if atty::is(Stream::Stdout) {
24    println!("I'm a terminal");
25  } else {
26    println!("I'm not");
27  }
28}
29```
30
31## testing
32
33This library has been unit tested on both unix and windows platforms (via appveyor).
34
35
36A simple example program is provided in this repo to test various tty's. By default.
37
38It prints
39
40```bash
41$ cargo run --example atty
42stdout? true
43stderr? true
44stdin? true
45```
46
47To test std in, pipe some text to the program
48
49```bash
50$ echo "test" | cargo run --example atty
51stdout? true
52stderr? true
53stdin? false
54```
55
56To test std out, pipe the program to something
57
58```bash
59$ cargo run --example atty | grep std
60stdout? false
61stderr? true
62stdin? true
63```
64
65To test std err, pipe the program to something redirecting std err
66
67```bash
68$ cargo run --example atty 2>&1 | grep std
69stdout? false
70stderr? false
71stdin? true
72```
73
74Doug Tangren (softprops) 2015-2019
75