voussoir/etiquette
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add some example invocations to the helptext.

Browse source
This commit is contained in:
voussoir 2021-01-15 00:34:05 -08:00
parent d3b3b9f321
commit 16f2517ca9
1 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
frontends/etiquette_cli.py
View file

@ -418,6 +418,9 @@ add_tag:
Add a tag to files by a filename glob. Add a tag to files by a filename glob.
> etiquette_cli.py add_tag tag_name glob_pattern > etiquette_cli.py add_tag tag_name glob_pattern
Examples:
> etiquette_cli.py add_tag wallpaper wall*.jpg
'''.strip(), '''.strip(),
remove_tag=''' remove_tag='''
@ -425,6 +428,9 @@ remove_tag:
Remove a tag from files by a filename glob. Remove a tag from files by a filename glob.
> etiquette_cli.py remove_tag tag_name glob_pattern > etiquette_cli.py remove_tag tag_name glob_pattern
Examples:
> etiquette_cli.py remove_tag watchlist spongebob*.mp4
'''.strip(), '''.strip(),
digest=''' digest='''
@ -446,6 +452,10 @@ digest:
--no_recurse: --no_recurse:
Do not recurse into subdirectories. Only create Photos from files in Do not recurse into subdirectories. Only create Photos from files in
the current directory. the current directory.
Examples:
> etiquette_cli.py digest media --ratelimit 1
> etiquette_cli.py digest photos --no-recurse --no-albums --ratelimit 0.25
'''.strip(), '''.strip(),
easybake=''' easybake='''
@ -629,7 +639,6 @@ tag_breplace:
> etiquette_cli.py tag_breplace replace_from replace_to > etiquette_cli.py tag_breplace replace_from replace_to
'''.strip(), '''.strip(),
) )
DOCSTRING = betterhelp.add_previews(DOCSTRING, SUB_DOCSTRINGS) DOCSTRING = betterhelp.add_previews(DOCSTRING, SUB_DOCSTRINGS)