>> First commit
> make project outline > tests are definitely wrong > may need to rewrite arg parsing
This commit is contained in:
commit
50d7189654
8 changed files with 1026 additions and 0 deletions
47
man.md
Normal file
47
man.md
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
# owl(1)
|
||||
|
||||
*The moon is bright. The owls are ready for the hunt.*
|
||||
|
||||
Owl is a file renaming tool; it removes character from file names which are
|
||||
not compatible with `FAT` file systems (typically `FAT32` or `exFAT`).
|
||||
|
||||
```
|
||||
owl COMMAND OPTIONS FILE1 FILE2 ...
|
||||
```
|
||||
|
||||
|
||||
## CLEAN COMMAND
|
||||
Rename `FILE`s given at the command line such that all `FAT`-incompatible
|
||||
characters are removed. By default it replaces invalid characters with
|
||||
`_U{Unicode Code Point}_`, but this can be changed, see the `--strategy`
|
||||
flag below.
|
||||
|
||||
## Options:
|
||||
|
||||
### -s, --strategy STRATEGY
|
||||
Change what happens to invalid characters. Choices are:
|
||||
|
||||
- "remove": just remove the characters. If left with an empty string, rename
|
||||
to "\_empty_".
|
||||
- "code-point": replace each character with "\_Unum_", where "num" is the
|
||||
Unicode Code Point of the character.
|
||||
|
||||
## HELP COMMAND
|
||||
Show a small help message.
|
||||
|
||||
## VERSION COMMAND
|
||||
Show version information.
|
||||
|
||||
|
||||
## GENERAL OPTIONS
|
||||
### -n, --dry-run
|
||||
Causes Owl to just print a representation of what would be done without
|
||||
actually renaming any files.
|
||||
|
||||
### -v, --version
|
||||
Causes the `version` command to be run, regardless of what other arguments
|
||||
are given.
|
||||
|
||||
### -h, --help
|
||||
Causes the `help` command to be run, regardless of what other arguments are
|
||||
given.
|
||||
Loading…
Add table
Add a link
Reference in a new issue