yetangitu/ffsend
1
0
Fork 0
mirror of https://github.com/timvisee/ffsend.git synced 2025-10-03 17:49:15 +02:00
Code Issues Projects Releases Packages Wiki Activity

Improve README

Browse source
This commit is contained in:
timvisee 2019-03-20 00:23:15 +01:00
parent 1376218d30
commit 14dbfdfd79
No known key found for this signature in database
GPG key ID: B8DB720BC383E172
1 changed files with 19 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

38
README.md
View file

@ -514,33 +514,33 @@ arguments to control `ffsend` without user interaction.
- `--no-interact` (`-I`): do not allow user interaction. For prompts not having - `--no-interact` (`-I`): do not allow user interaction. For prompts not having
a default value, the application will quit with an error, unless `--yes` a default value, the application will quit with an error, unless `--yes`
or `--force` is provided. or `--force` is provided.
This should **always** be given when using automated scripting. This should **always** be given when using automated scripting.
- Example: when uploading a directory, providing this flag will stop the Example: when uploading a directory, providing this flag will stop the
archive question prompt form popping up, and will archive the directory as archive question prompt form popping up, and will archive the directory as
default option. default option.
- `--yes` (`-y`): assume the yes option for yes/no prompt by default. - `--yes` (`-y`): assume the yes option for yes/no prompt by default.
- Example: when downloading a file that already exists, providing this flag Example: when downloading a file that already exists, providing this flag
will assume yes when asking to overwrite a file. will assume yes when asking to overwrite a file.
- `--force` (`-f`): force to continue with the action, skips any warnings that - `--force` (`-f`): force to continue with the action, skips any warnings that
would otherwise quit the application. would otherwise quit the application.
- Example: when uploading a file that is too big, providing this flag will Example: when uploading a file that is too big, providing this flag will
ignore the file size warning and forcefully continues. ignore the file size warning and forcefully continues.
- `--quiet` (`-q`): be quiet, print as little information as possible. - `--quiet` (`-q`): be quiet, print as little information as possible.
- Example: when uploading a file, providing this flag will only output the Example: when uploading a file, providing this flag will only output the
final share URL. final share URL.
Generally speaking, you could use the following rules when automating: Generally speaking, use the following rules when automating:
- Always use `--no-interact` (`-I`). - Always provide `--no-interact` (`-I`).
- When invoking an action you want to complete no matter what, - Provide any combination of `--yes` (`-y`) and `--force` (`-f`) for actions you
use any combination of `--yes` (`-y`) and `--force` (`-f`). want to complete no matter what.
- When passing share URLs along, use the `--quiet` (`-q`) flag, when uploading - When passing share URLs along, provide the `--quiet` (`-q`) flag, when
for example. uploading for example.
These flags can also automatically be set by defining environment variables as These flags can also automatically be set by defining environment variables as
specified here: specified here:
[» Configuration and environment](#configuration-and-environment) [» Configuration and environment](#configuration-and-environment)
Here are some example commands in `bash`: Here are some examples commands in `bash`:
```bash ```bash
# Stop on error # Stop on error
set -e set -e
@ -566,13 +566,13 @@ ffsend -I password $URL --password="secret"
export FFSEND_NO_INTERACT=1 FFSEND_FORCE=1 FFSEND_YES=1 export FFSEND_NO_INTERACT=1 FFSEND_FORCE=1 FFSEND_YES=1
# Download the uploaded file, overwriting the local variant due to variables # Download the uploaded file, overwriting the local variant due to variables
ffsend -If download $URL --password="secret" ffsend download $URL --password="secret"
``` ```
For more information on these arguments, use `ffsend help` and check out: For more information on these arguments, invoke `ffsend help` and check out:
[» Configuration and environment](#configuration-and-environment) [» Configuration and environment](#configuration-and-environment)
For other questions regarding automation, or feature requests, be sure to For other questions regarding automation or feature requests, be sure to
[open](https://github.com/timvisee/ffsend/issues/) an issue. [open](https://github.com/timvisee/ffsend/issues/) an issue.
## Security ## Security