소스 검색

added some descriptions

Fabian Peter Hammerle 7 년 전
부모
커밋
c1523460e3
2개의 변경된 파일17개의 추가작업 그리고 3개의 파일을 삭제
  1. 14 2
      README.md
  2. 3 1
      scripts/xrandrl

+ 14 - 2
README.md

@@ -1,6 +1,6 @@
 # xrandrl
 
-show names of outputs available to x server.
+Show names of outputs available to the X server.
 
 ## Requirements
 
@@ -8,7 +8,19 @@ show names of outputs available to x server.
 sudo apt-get install python3 libx11-dev libxrandr-dev
 ```
 
-## Examples
+## Usage
+
+```
+xrandrl [-h] [-c] [-d] [-e]
+
+optional arguments:
+  -c, --connected  connected only
+  -d, --disabled   disabled only (does not imply --connected)
+  -e, --enabled    enabled only (does not imply --connected)
+  -h, --help       show help message and exit
+```
+
+### Examples
 
 ```{sh}
 $ xrandrl --connected

+ 3 - 1
scripts/xrandrl

@@ -150,7 +150,9 @@ def process(connected, disabled, enabled):
 
 def _init_argparser():
     import argparse
-    argparser = argparse.ArgumentParser(description=None)
+    argparser = argparse.ArgumentParser(
+        description='Show names of outputs available to the X server.',
+    )
     argparser.add_argument(
         '-c', '--connected',
         action='store_true',