diff --git a/README.md b/README.md index b4fce46..70a71fb 100644 --- a/README.md +++ b/README.md @@ -6,20 +6,18 @@ Owl is a command line tool for removing unwanted characters from file names. Say you want to backup some of your files on to a memory stick. Most likely that memory stick uses `FAT32` or `exFAT` as its file system, as this is the most compatible with the most operating systems. But if any of your files -have special characters like `:` or `?` in their names, this won't work (see -, -section 7.7.3 for more details). +have special characters like `:` or `?` in their names, this won't work +[1](#links). Alternatively, say you have a file that needs to be on an older computer -that will not render some characters (like multi-character emoji) -correctly1. +that will not render some characters (like multi-character emoji) correctly +(or you just don't like having emoji in a file name). And what if you have either of these problems with potentially many files in a directory? Renaming every file would be tedious, and even the best bulk renaming tool will struggle to deal with all the possible invalid characters, at least if you don't want to manually write a very complex -[regular expression](https://en.wikipedia.org/wiki/Regular_expression) every -time you encounter this problem. +regular expression every time you encounter this problem. Owl will hunt down any files with these issues and rename them as appropriate - see `man.md` for usage. @@ -27,4 +25,14 @@ appropriate - see `man.md` for usage. --- -1. Or you just don't like having emoji in a file name. +## Links + +1. A Stack Exchange question which outlines some of the problems in this area: +2. Another, similar stack exchange question: +3. FAT Specification: + + (see section 7.7.3) +4. More file system specifications: +5. mmv: +6. PathShortener: +7. fuseblk-filename-fixer: diff --git a/man.md b/man.md index 4005b78..d9e292e 100644 --- a/man.md +++ b/man.md @@ -16,7 +16,7 @@ flag below. ## Options: -### -s, --strategy STRATEGY +### -s, \-\-strategy STRATEGY Change what happens to invalid characters. Choices are: - "remove": just remove the characters. If left with an empty string, rename @@ -24,12 +24,12 @@ Change what happens to invalid characters. Choices are: - "represent": replace each character with "\_Unum_", where "num" is the Unicode Code Point of the character. -### -n, --dry-run +### -n, \-\-dry-run Causes Owl to just print a representation of what would be done without actually renaming any files. -### -v, --version +### -v, \-\-version Show version information. -### -h, --help +### -h, \-\-help Show a small help message.