Skip to content

Commit

Permalink
Correct doc
Browse files Browse the repository at this point in the history
  • Loading branch information
gvellut committed Feb 19, 2023
1 parent 2df44b8 commit 042b300
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,8 +229,6 @@ Just like the login and password, other options can be set in a configuration fi
- CONTENT
- NOREPLACE

The options that set flags (BYVOLUME and below in the list above) should have one of the following values: `1`, `true`, `t`, `yes`, `y` or `on`. The value can be in upper case. For unsetting, the simplest is to remove the environment variable (the default value for all those flags is `False`). If a value is passed, it should be one of the following: `0`, `false`, `f`, `no`, `n` or `off`.

To set an option, use the `jncep config set` command. For example:

```console
Expand All @@ -243,6 +241,12 @@ This will add a value for the OUTPUT configuration option. When the `jncep epub`

[See the paragraph about managing the configuration](#config) further in this page.

#### Flags

The options that set flags (BYVOLUME and below in the list above) should have one of the following values: `1`, `true`, `t`, `yes`, `y` or `on`. The value can be in upper case.

For unsetting, the simplest is to use `config unset` to remove the configuration option (the default value for all those flags is `False`). If a value is set, it should be one of the following: `0`, `false`, `f`, `no`, `n` or `off`.

### Environment variables

The options can also be set using an environment variable. They are the same as the configuration options, but with a `JNCEP_` prefix:
Expand All @@ -265,7 +269,7 @@ The priority order for option values is as follows:
1. If a value is passed on the command-line, it has the highest priority
2. If no value is passed, the value is taken from an environment variable if present
3. After that, the value is taken from the configuration file
4. Some options have a default value defined in the code: If no value has been explicitly passed using one of the 3 methods above, that default value will be used. Some options have no default values and are instead required: If no value is passed using one of the 3 methods just described, it will raise an error.
4. Some options have a default value defined in the code: If no value has been explicitly passed using one of the 3 methods above, that default value will be used. Some options have no default values and are instead required: If no value is passed using one of the 3 methods just described, this will raise an error.

## track

Expand Down Expand Up @@ -553,7 +557,7 @@ EMAIL Login email for J-Novel Club account
...
```

They are the same options than can be set using environment variables (except there is no `JNCEP_` prefix).
The same options can be set using environment variables (except there is a `JNCEP_` prefix).

### set

Expand Down

0 comments on commit 042b300

Please sign in to comment.