Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mikedilger committed Dec 30, 2024
1 parent 7506ee7 commit b0c3cd0
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 6 deletions.
2 changes: 2 additions & 0 deletions docs/COMMANDS.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ This file may not be up to date. You can see the list of all the commands with `

You can see the details of a particular command with `gossip help <command>`.

Gossip logging goes to stderr, while command output goes to stdout.

## Commands that launch the GUI program

### login
Expand Down
24 changes: 24 additions & 0 deletions docs/EXECUTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Execution

## Logs

Many people run programs by double-clicking an icon and interacting only with the GUI window.

But while gossip is a GUI desktop program, it also outputs a lot of messages to the console as it runs. I recommend you keep the console open and pay some attention to errors or other odd behavior that may become apparent from the console messages.

Gossip logs a lot, and important messages can get missed. In order to only see the important messages, you can change the log level. Every log message is tagged by a log level, one of `error`, `warn`, `info`, `debug` or `trace`. You can specify a cut-off to see fewer messages by setting the environment variable `RUST_LOG` to the level you desire, such as `RUST_LOG=warn`. If not specified otherwise, gossip defaults to the `info` log level.

There are other things you can specify in `RUST_LOG`, such as which level to log on a crate-by-crate basis. For example: `RUST_LOG="warn,gossip=info,gossip_lib=info,nostr_types=info"`

Gossip logs to stderr by default now (this used to be stdout). This helps differentiate log messages from command line outputs.


## Backtraces

This is usually not necessary. But if gossip is panicking you can get backtrace information by setting the environment variable `RUST_BACKTRACE=1` when executing gossip.

## Command Line Usage

Gossip has a lot of command line commands for tweaking things or extracting bits of information from its database.

See [Gossip Commands](COMMANDS.md)
8 changes: 2 additions & 6 deletions docs/INSTALLATION_AND_USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,9 @@ See [Installation](INSTALLATION.md) for available packages and building from sou

See [Configuration](CONFIGURATION.md) for configuration.

## Command Line Usage
## Execution

Gossip is a GUI desktop program, but it also outputs a lot of messages to the console as it runs. I recommend you keep the console open and pay some attention to errors or other odd behavior that may become apparent from the console messages.

Gossip has a lot of command line commands for tweaking things or extracting bits of information from its database.

See [Gossip Commands](COMMANDS.md)
See [Execution](EXECUTION.md) for execution options.

## Troubleshooting

Expand Down

0 comments on commit b0c3cd0

Please sign in to comment.