From b2e03031a6a8c1c9942537a252020dd90a855cff Mon Sep 17 00:00:00 2001 From: Karl Voit Date: Tue, 2 Sep 2025 17:12:25 +0200 Subject: [PATCH] initial documentation of --gui parameter; fixed README --- README.org | 129 ----------------------------------------------------- 1 file changed, 129 deletions(-) diff --git a/README.org b/README.org index 380a884..b958db5 100644 --- a/README.org +++ b/README.org @@ -105,135 +105,6 @@ dependencies =uv= is looking for. # ./filetags/__init__.py --help | sed 'sX/home/vkX\$HOMEX' # #+END_SRC -#+BEGIN_src -usage: ./filetags/__init__.py [-h] [-t "STRING WITH TAGS"] [--remove] [-i] - [-R] [-s] [--hardlinks] [-f] - [--filebrowser PATH_TO_FILEBROWSER] [--tagtrees] - [--tagtrees-handle-no-tag "treeroot" | "ignore" | "FOLDERNAME"] - [--tagtrees-link-missing-mutual-tagged-items] - [--tagtrees-dir ] - [--tagtrees-depth TAGTREES_DEPTH] [--ln] [--la] - [--lu] [--tag-gardening] [-v] [-q] [--version] - [FILE [FILE ...]] - -This tool adds or removes simple tags to/from file names. - -Tags within file names are placed between the actual file name and -the file extension, separated with " -- ". Multiple tags are -separated with " ": - Update for the Boss -- projectA presentation.pptx - 2013-05-16T15.31.42 Error message -- screenshot projectB.png - -This easy to use tag system has a drawback: for tagging a larger -set of files with the same tag, you have to rename each file -separately. With this tool, this only requires one step. - -Example usages: - filetags --tags="presentation projectA" *.pptx - … adds the tags "presentation" and "projectA" to all PPTX-files - filetags --tags="presentation -projectA" *.pptx - … adds the tag "presentation" to and removes tag "projectA" from all PPTX-files - filetags -i * - … ask for tag(s) and add them to all files in current folder - filetags -r draft *report* - … removes the tag "draft" from all files containing the word "report" - -This tools is looking for the optional first text file named ".filetags" in -current and parent directories. Each of its lines is interpreted as a tag -for tag completion. Multiple tags per line are considered mutual exclusive. - -Verbose description: http://Karl-Voit.at/managing-digital-photographs/ - -positional arguments: - FILE One or more files to tag - -optional arguments: - -h, --help show this help message and exit - -t "STRING WITH TAGS", --tags "STRING WITH TAGS" - One or more tags (in quotes, separated by spaces) to - add/remove - --remove Remove tags from (instead of adding to) file name(s) - -i, --interactive Interactive mode: ask for (a)dding or (r)emoving and - name of tag(s) - -R, --recursive Recursively go through the current directory and all - of its subdirectories. Implemented for --tag-gardening - and --tagtrees - -s, --dryrun Enable dryrun mode: just simulate what would happen, - do not modify files - --hardlinks Use hard links instead of symbolic links. This is - ignored on Windows systems. Note that renaming link - originals when tagging does not work with hardlinks. - -f, --filter Ask for list of tags and generate links in - "$HOME/.filetags_tagfilter" containing links to all - files with matching tags and start the filebrowser. - Target directory can be overridden by --tagtrees-dir. - --filebrowser PATH_TO_FILEBROWSER - Use this option to override the tool to view/manage - files (for --filter; default: geeqie). Use "none" to - omit the default one. - --tagtrees This generates nested directories in - "$HOME/.filetags_tagfilter" for each combination of - tags up to a limit of 2. Target directory can be - overridden by --tagtrees-dir. Please note that this - may take long since it relates exponentially to the - number of tags involved. Can be combined with - --filter. See also http://Karl-Voit.at/tagstore/ and - http://Karl-Voit.at/tagstore/downloads/Voit2012b.pdf - --tagtrees-handle-no-tag "treeroot" | "ignore" | "FOLDERNAME" - When tagtrees are created, this parameter defines how - to handle items that got no tag at all. The value - "treeroot" is the default behavior: items without a - tag are linked to the tagtrees root. The value - "ignore" will not link any non-tagged items at all. - Any other value is interpreted as a folder name within - the tagreees which is used to link all non-tagged - items to. - --tagtrees-link-missing-mutual-tagged-items - When the controlled vocabulary holds mutual exclusive - tags (multiple tags in one line) this option generates - directories in the tagtrees root that hold links to - items that have no single tag from those mutual - exclusive sets. For example, when "draft final" is - defined in the vocabulary, all items without "draft" - and "final" are linked to the "no-draft-final" - directory. - --tagtrees-dir - When tagtrees are created, this parameter overrides - the default target directory - "$HOME/.filetags_tagfilter" with a user-defined - one. It has to be an empty directory or a non-existing - directory which will be created. This also overrides - the default directory for --filter. - --tagtrees-depth TAGTREES_DEPTH - When tagtrees are created, this parameter defines the - level of depth of the tagtree hierarchy. The default - value is 2. Please note that increasing the depth - increases the number of links exponentially. - Especially when running Windows (using lnk-files - instead of symbolic links) the performance is really - slow. Choose wisely. - --ln, --list-tags-by-number - List all file-tags sorted by their number of use - --la, --list-tags-by-alphabet - List all file-tags sorted by their name - --lu, --list-tags-unknown-to-vocabulary - List all file-tags which are found in file names but - are not part of .filetags - --tag-gardening This is for getting an overview on tags that might - require to be renamed (typos, singular/plural, ...). - See also http://www.webology.org/2008/v5n3/a58.html - -v, --verbose Enable verbose mode - -q, --quiet Enable quiet mode - --version Display version and exit - -:copyright: (c) by Karl Voit -:license: GPL v3 or any later version -:URL: https://github.com/novoid/filetags -:bugreports: via github or -:version: 2018-08-02 -· -#+END_src - #+BEGIN_SRC usage: filetags [-h] [-t "STRING WITH TAGS"] [--remove] [-i] [--gui] [-R] [-s] [--overwrite] [--hardlinks] [-f] [--filebrowser PATH_TO_FILEBROWSER]