documentation improvements

master
Lynne Megido 4 months ago
parent e59580b892
commit dc9eb2fa3b
Signed by: lynnesbian
GPG Key ID: F0A184B5213D9F90
  1. 19
      README.md
  2. 8
      doc/README.md

@ -140,6 +140,25 @@ You can also manually specify an output format to use:
fif -O powershell ~/Documents > output.ps1
```
#### The `--fix` flag
If, however, you'd rather have fif fix the misnamed files itself, rather than relying on a shell script, you can use
the `--fix` flag:
```bash
# rename any misnamed .jpg files in the user's pictures directory
fif ~/Pictures --fix -e jpg
# fix any misnamed files found in the user's downloads
fif ~/Downloads --fix
```
By default, fif will avoid taking any potentially destructive actions (renaming a file to a name that already exists).
This behaviour can be disabled with the `--overwrite` flag, which will instead prompt you to overwrite the existing
file. fif will also prompt you to retry on errors.
For more information on how the `--fix` flag works, and how it behaves in conjunction with the `--overwrite` flag
and `--prompt` parameter, see [the corresponding wiki page](https://gitlab.com/Lynnesbian/fif/-/wikis/Fix).
### Logging
By default, fif will log any info, warnings, and errors encountered during execution. This can be changed with the `-v`
flag:

@ -0,0 +1,8 @@
Where's the documentation?
===
If you're looking for documentation on fif, try checking...
- The built-in help documentation, by running `fif --help`
- [The usage section in the README file](https://gitlab.com/Lynnesbian/fif/-/blob/master/README.md#usage), for a
brief overview of fif's functionality and how to use it
- [The wiki](https://gitlab.com/Lynnesbian/fif/-/wikis/home), for more detailed information on fif's behaviour
- [Docs.rs](https://docs.rs/fif/latest/fif/), for information pertaining to fif's internals
Loading…
Cancel
Save