SixteenThousand/owl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
owl/man.md

2.1 KiB
Raw Blame History

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 ...

Rename FILEs 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_".
  • "represent": replace each character with "_Unum_", where "num" is the Unicode Code Point of the character.

-n, --dry-run

Causes Owl to just print a representation of what would be done without actually renaming any files.

-v, --version

Show version information.

-h, --help

Show a small help message.

Edge Cases & Other Tidbits

What doesn't FAT allow?

Mainly *<>\|/:?'

What about whitespace?

Some of these (like tab, line feed, and carriage return) are not valid under FAT and will be removed.

If a sequence of invalid characters surrounded by spaces is in one of the file names, and the remove strategy is being used, then you will be left with multiple whitespace characters in a row. For example,

"Really questionable ?? filename"

will become

"Really questionable  filename"

with a double space before "filename".

What about invalid UTF-8?

This is removed and replaced with "_INVALID_". This replacement is done before anything else.

What about UTF-16/Windows?

Owl has only been tested so far on Linux with a UTF-8 locale. UTF-16 support on Windows is likely possible, but has not been tested. Please contact me if you would like Windows support (see below).

AUTHORS & COPYRIGHT

Written by user SixteenThousand of github.com (email thomsixteenthousand@gmail.com) and licensed under the GNU General Public License version 3 (GPL v3). See https://www.gnu.org/licenses/ for more information.