Commit 28fbec77 authored by MinchinWeb's avatar MinchinWeb

Document `ls`' 'n' switch

parent 93544521
...@@ -73,7 +73,7 @@ class ListCommand(ExpressionCommand): ...@@ -73,7 +73,7 @@ class ListCommand(ExpressionCommand):
try: try:
self.limit = int(value) self.limit = int(value)
except ValueError: except ValueError:
pass # use default value in configuration pass # use default value in configuration
elif opt == '-i': elif opt == '-i':
self.ids = value.split(',') self.ids = value.split(',')
...@@ -142,7 +142,7 @@ class ListCommand(ExpressionCommand): ...@@ -142,7 +142,7 @@ class ListCommand(ExpressionCommand):
def usage(self): def usage(self):
return """Synopsis: ls [-x] [-s <sort_expression>] [-f <output format>] return """Synopsis: ls [-x] [-s <sort_expression>] [-f <output format>]
[-F <format string>] [expression]""" [-F <format string>] [-i <item numbers>] [-n <integer>] [expression]"""
def help(self): def help(self):
return """\ return """\
...@@ -193,6 +193,7 @@ When an expression is given, only the todos matching that expression are shown. ...@@ -193,6 +193,7 @@ When an expression is given, only the todos matching that expression are shown.
A tab character serves as a marker to start right alignment. A tab character serves as a marker to start right alignment.
-i : Comma separated list of todo IDs to print. -i : Comma separated list of todo IDs to print.
-n : Number of items to display. Defaults to the value in the configuration.
-s : Sort the list according to a sort expression. Defaults to the expression -s : Sort the list according to a sort expression. Defaults to the expression
in the configuration. in the configuration.
-x : Show all todos (i.e. do not filter on dependencies or relevance). -x : Show all todos (i.e. do not filter on dependencies or relevance).
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment