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

>> add links section to README

Browse source 
>> fix double dashes in man page
This commit is contained in:
Thomas Lindop 2025-05-22 21:44:56 +01:00
parent 923b5aa1a4
commit d980b3668f
2 changed files with 20 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -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 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 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 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 have special characters like `:` or `?` in their names, this won't work
<https://learn.microsoft.com/en-gb/windows/win32/fileio/exfat-specification>, [1](#links).
section 7.7.3 for more details).
Alternatively, say you have a file that needs to be on an older computer Alternatively, say you have a file that needs to be on an older computer
that will not render some characters (like multi-character emoji) that will not render some characters (like multi-character emoji) correctly
correctly<sup>1</sup>. (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 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 a directory? Renaming every file would be tedious, and even the best bulk
renaming tool will struggle to deal with all the possible invalid 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 characters, at least if you don't want to manually write a very complex
[regular expression](https://en.wikipedia.org/wiki/Regular_expression) every regular expression every time you encounter this problem.
time you encounter this problem.
Owl will hunt down any files with these issues and rename them as Owl will hunt down any files with these issues and rename them as
appropriate - see `man.md` for usage. 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: <https://unix.stackexchange.com/questions/779052/removing-hidden-control-characters-in-filenames>
2. Another, similar stack exchange question: <https://stackoverflow.com/questions/1976007/what-characters-are-forbidden-in-windows-and-linux-directory-names>
3. FAT Specification:
<https://learn.microsoft.com/en-gb/windows/win32/fileio/exfat-specification>
(see section 7.7.3)
4. More file system specifications: <https://learn.microsoft.com/en-us/troubleshoot/windows-client/backup-and-storage/fat-hpfs-and-ntfs-file-systems?source=recommendations>
5. mmv: <https://github.com/rrthomas/mmv>
6. PathShortener: <https://github.com/ElectricRCAircraftGuy/eRCaGuy_PathShortener>
7. fuseblk-filename-fixer: <https://github.com/DDR0/fuseblk-filename-fixer>

8
man.md
View file

@ -16,7 +16,7 @@ flag below.
## Options: ## Options:
### -s, --strategy STRATEGY ### -s, \-\-strategy STRATEGY
Change what happens to invalid characters. Choices are: Change what happens to invalid characters. Choices are:
- "remove": just remove the characters. If left with an empty string, rename - "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 - "represent": replace each character with "\_Unum_", where "num" is the
Unicode Code Point of the character. 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 Causes Owl to just print a representation of what would be done without
actually renaming any files. actually renaming any files.
### -v, --version ### -v, \-\-version
Show version information. Show version information.
### -h, --help ### -h, \-\-help
Show a small help message. Show a small help message.