medialist-cli
Fork

Dépôt original, Pas de origine de fork

Commit

Update the man file.

FossilOrigin-Name: 1f78bd33013dc2ef636af8c21b18dd02db0480e5fb95b1129fbb8125a7b909d0

--- a/man/medialist-cli.1

+++ b/man/medialist-cli.1

		@@ -1,4 +1,4 @@
1		-.TH MEDIALIST-CLI 1 "2021-07-31" "0.1" "MediaList Suite"
	1	+.TH MEDIALIST-CLI 1 "2021-11-25" "0.2-pre" "MediaList Suite"
2	2	.SH NAME
3	3	medialist-cli \- CLI for MediaList
4	4	.SH SYNOPSIS

		@@ -61,7 +61,7 @@ is provided, then the corresponding item is deleted from the list. In this case,
61	61	the list itself isn't deleted.
62	62	.RE
63	63	.TP
64		-show <listname> [\fB-n\fP]
	64	+show <listname> [\fB-n\fP \| \fB--numbered\fP] [\fB--show-headers\fP]
65	65	.RS
66	66	Show the contents of a \fIlistname\fP.
67	67	.PP

		@@ -73,15 +73,30 @@ for the
73	73	and
74	74	.I delete
75	75	commands.
	76	+.PP
	77	+The
	78	+.I --show-headers
	79	+flag will print the headers for each field at the beginning.
76	80	.RE
77	81	.TP
78	82	update <list> <id> [\fBoptions\fP]
79	83	This will update the item with \fIid\fP on \fIlist\fP with the changes specified
80	84	in \fIoptions\fP.
81	85	.IP
82		-Potential options are: --title TITLE; --status STATUS; --progress PROGRESS. The
83		-later two share the same meaning from \fIadd\fP, while \fItitle\fP will change
84		-the item's title.
	86	+Potential options are: --title TITLE; --status STATUS; --progress PROGRESS;
	87	+--start-date DATE; --end-date DATE. The
	88	+.I --status
	89	+and
	90	+.I --progress
	91	+share the same meaning from \fIadd\fP, while \fItitle\fP will change the item's
	92	+title.
	93	+.IP
	94	+.I --start-date
	95	+and
	96	+.I --end-date
	97	+will update the start and end dates for the specified item, currently these
	98	+aren't used anywhere else in the program, but there are plans for them to
	99	+be used later. The DATE for these is in the form \fIYYYY-MM-DD\fP.
85	100	.SH EXAMPLES
86	101	.TP
87	102	medialist-cli create manga

		@@ -107,11 +122,10 @@ Deletes the item with ID "1" from the list "manga". As an ID is supplied, the
107	122	list itself isn't deleted.
108	123	.SH FILES
109	124	.TP
110		-.I ~/.config/medialist/medialist.conf
	125	+.I $XDG_CONFIG_HOME/medialist/medialist.conf
111	126	Configuration file for all MediaList programs.
112	127	.SH BUGS
113		-The configuration file isn't correctly read with environment variables or
114		-paths that begin with a tilde.
	128	+No known bugs.
115	129	." .SH "SEE ALSO"
116	130	." .BR medialist (5).
117	131	.SH COPYRIGHT