From: Urban Wallasch Date: Wed, 23 Jun 2021 16:20:52 +0000 (+0200) Subject: * Improved command line usage help. X-Git-Tag: v0.1.0~55 X-Git-Url: https://git.packet-gain.de/?a=commitdiff_plain;h=95aba08d7fddbef9b323d7a6c97df719cb47a255;p=jiten-pai.git * Improved command line usage help. --- diff --git a/README.md b/README.md index af07962..a19098c 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,27 @@ dictionary copyright information and licensing terms. will not be available. +## Command Line + +Jiten-pai supports a few command line options which might come in handy +for workflow integration. They should be fairly self explaining: +``` + usage: jiten-pai.py [-h] [-k] [-c] [-v] [-l KANJI] [-w WORD] + + Jiten-pai Japanese dictionary + + optional arguments: + -h, --help show this help message and exit + -k, --kanjidic start with KanjiDic + -c, --clip-kanji look up kanji from clipboard + -v, --clip-word look up word from clipboard + -l KANJI, --kanji-lookup KANJI look up KANJI in kanji dictionary + -w WORD, --word-lookup WORD look up WORD in word dictionary + + Only one of these options should be used at a time. +``` + + ## Known issues * *TBD* diff --git a/jiten-pai.py b/jiten-pai.py index adb94d7..0eebdd3 100755 --- a/jiten-pai.py +++ b/jiten-pai.py @@ -1463,15 +1463,15 @@ def dict_lookup(dict_fname, pattern, mode, limit=0): def _parse_cmdline(): parser = ArgumentParser( - formatter_class=RawTextHelpFormatter, + formatter_class=lambda prog: RawTextHelpFormatter(prog, max_help_position=40), description='Jiten-pai Japanese dictionary', - epilog='\n' + epilog='Only one of these options should be used at a time.\n' ) parser.add_argument('-k', '--kanjidic', action='count', help='start with KanjiDic') parser.add_argument('-c', '--clip-kanji', action='count', help='look up kanji from clipboard') + parser.add_argument('-v', '--clip-word', action='count', help='look up word from clipboard') parser.add_argument('-l', '--kanji-lookup', metavar='KANJI', help='look up KANJI in kanji dictionary') parser.add_argument('-w', '--word-lookup', metavar='WORD', help='look up WORD in word dictionary') - parser.add_argument('-v', '--clip-word', action='count', help='look up word from clipboard') return parser.parse_args() def main(): diff --git a/kanjidic.py b/kanjidic.py index 4075e9e..af10375 100755 --- a/kanjidic.py +++ b/kanjidic.py @@ -895,9 +895,9 @@ class kdMainWindow(QDialog): def _parse_cmdline(): parser = ArgumentParser( - formatter_class=RawTextHelpFormatter, + formatter_class=lambda prog: RawTextHelpFormatter(prog, max_help_position=40), description='Jiten-pai kanji dictionary', - epilog='\n' + epilog='Only one of these options should be used at a time.\n' ) parser.add_argument('-c', '--clip-kanji', action='count', help='look up kanji from clipboard') parser.add_argument('-l', '--kanji-lookup', metavar='KANJI', help='look up KANJI in kanji dictionary')