Просмотр исходного кода

doc: misc/tau: add missing commands and general doc update

dasman 2 лет назад
Родитель
Сommit
759122b379
2 измененных файлов с 17 добавлено и 16 удалено
  1. 2 0
      bin/tau/tau-python/tau
  2. 15 16
      doc/src/misc/tau.md

+ 2 - 0
bin/tau/tau-python/tau

@@ -552,6 +552,8 @@ SUBCOMMANDS:
     stop       Stop task(s).
     switch     Switch between configured workspaces.
     show       List filtered tasks.
+    export	   Save current workspace tasks to a path.
+    import	   Load current workspace tasks from a path.
     help       Show this help text.
 
 Examples:

+ 15 - 16
doc/src/misc/tau.md

@@ -56,6 +56,8 @@ To run your own instance check [Local Deployment](#local-deployment)
 		stop       Stop task(s).
 		switch     Switch between configured workspaces.
 		show       List filtered tasks.
+		export	   Save current workspace tasks to a path.
+		import	   Load current workspace tasks from a path.
 		help       Show this help text.
 
 
@@ -85,37 +87,34 @@ for a description which allows entering multiline text.
 ```
 
 
-#### List tasks
+#### List and filtering tasks
 
 ```shell
-% tau				# all non-stop tasks
-% tau 1-3			# tasks 1 to 3
+% tau					# all non-stop tasks
+% tau 1-3				# tasks 1 to 3
 % tau show state:open	# list open tasks
-% tau rank:2			# all tasks that have rank 2
-% tau @dave			# tasks that assign field is "dave"
+% tau show rank:2		# all tasks that have rank 2
+% tau show @dave		# tasks that assign field is "dave"
 ```
 
 
-#### Filtering tasks
+#### Modify tasks
 
 Note: mod commands are: start, open, pause, stop and modify.
 
-Note: All filters from the previous section could work with mod commands.
-
 ```shell
-% tau 5 stop			# will stop task 5
-% tau 1,3 start			# start 1 and 3
-% tau 2 pause			# pause 2
-% tau 2,4 modify due:2009	# edit due to September in tasks 2 and 4 
+% tau 5 stop					# will stop task 5
+% tau 1,3 start					# start 1 and 3
+% tau 2 pause					# pause 2
+% tau 2,4 modify due:2009		# edit due date to September in tasks 2 and 4 
 % tau 1-4 modify project:tau	# edit project to tau in tasks 1,2,3 and 4
-% tau state:pause open		# open paused tasks
 ```
 
 #### Comments
 
 ```shell
 % tau 1 comment "content foo bar"	# will add a comment to task 1
-% tau 3 comment				# will open the editor to write a comment
+% tau 3 comment						# will open the editor to write a comment
 ```
 
 #### Export and Import
@@ -125,7 +124,7 @@ Note: All filters from the previous section could work with mod commands.
 % tau import ~/example_dir	# will reload saved json files from the path
 ```
 
-### archive
+#### Archive
 
 ```shell
 % tau archive                 # current month's completed tasks
@@ -136,7 +135,7 @@ Note: All filters from the previous section could work with mod commands.
 #### Switch workspace
 
 ```shell
-% tau switch darkfi	# darkfi workspace needs to be configured in config file
+% tau switch darkfi-dev		# darkfi-dev workspace needs to be configured in config file
 ```
 
 In addition to indexing tasks by there IDs, one can use their RefID (Reference ID):