Skip to content

Commit

Permalink
Extend documentation on DEBUG_FD and DEBUG_COLORS
Browse files Browse the repository at this point in the history
Move 'stderr vs stdout' and 'Save debug output to a file' to their own heading.
Fix #205
  • Loading branch information
mattlyons0 committed Oct 16, 2015
1 parent dc983db commit 3fac232
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,10 +114,14 @@ setInterval(function(){
Colored output looks something like:

![](https://cloud.githubusercontent.com/assets/71256/3139768/b98c5fd8-e8ef-11e3-862a-f7253b6f47c6.png)

## Output streams


### stderr vs stdout

You can set an alternative logging method per-namespace by overriding the `log` method on a per-namespace or globally:
By default `debug` will log to stderr, however this can be changed by setting the environment variable `DEBUG_FD` to `1` for stdout and `2` for stderr (the default value).

You can also set an alternative logging method per-namespace by overriding the `log` method on a per-namespace or globally:

Example _stdout.js_:

Expand Down Expand Up @@ -151,6 +155,12 @@ Example:
$ DEBUG_FD=3 node your-app.js 3> whatever.log
```

### Terminal colors

By default colors will only be used in a TTY. However this can be overridden by setting the environment variable `USE_COLORS` to `1`.

Note: Certain IDEs (such as WebStorm) don't support colors on stderr. In these cases you must set `USE_COLORS` to `1` and additionally change `DEBUG_FD` to `1`.

## Authors

- TJ Holowaychuk
Expand Down

0 comments on commit 3fac232

Please sign in to comment.