Commit: 30ced427ac1b0f30aacfa066d4ec901f89771227 - medialist-cli (git)

CLI interface to medialist (fossil mirror)

Commit MetaInfo

• Révision: 30ced427ac1b0f30aacfa066d4ec901f89771227 (tree)
• l'heure: 2023-03-16 15:45:51
• Auteur: mio <stigma@disr...>
• Commiter: mio

Message de Log

Update manpage to include 'import' and 'export' command. Prepare for version 0.4.

FossilOrigin-Name: 981787a07e271f740bd51ca47a9e08ab0b1cd8848772fd68ebc68ea35d0e7d78

Change Summary

• modified: man/medialist-cli.1

Modification

--- a/man/medialist-cli.1
+++ b/man/medialist-cli.1
@@ -1,4 +1,4 @@
-.TH MEDIALIST-CLI 1 "2022-02-18" "0.3" "MediaList Suite"
+.TH MEDIALIST-CLI 1 "2023-03-16" "0.4" "MediaList CLI"
 .SH NAME
 medialist-cli \- CLI for MediaList
 .SH SYNOPSIS
@@ -9,7 +9,8 @@ medialist-cli
 .OP command_options...
 .SH DESCRIPTION
 medialist-cli acts as the command-line interface for the MediaList suite of
-programs.
+programs. With it you can create an update lists to help keep track of which
+books you are reading, or which movies/tv shows you are watching.
 .SH OPTIONS
 .TP
 --help
@@ -61,6 +62,55 @@ is provided, then the corresponding item is deleted from the list. In this case,
 the list itself isn't deleted.
 .RE
 .TP
+export <listname> [\fB-t\fP | \fB--type TYPE\fP]
+.RS
+Export the list
+.I listname
+using the specified output
+.I TYPE
+to the standard output.  The potentian values for
+.I TYPE
+are: "json" (the default) and "html". The JSON output type will write a
+standard JSON formatted object to the standard output, while the HTML
+option will print a HTML Table to the standard output.
+.RE
+.TP
+import <list.json> [\fB--update\fP] [\fB--overwrite\fP] [\fB--overwrite-list\fP]
+.RS
+Import a JSON formatted list. If the list doesn't exist, then a new list is
+created and filled with the contents of
+.I list.json
+\&. It should also be mentioned that the name of
+.I list.json
+has no impact on which list to update, that information is stored in the
+JSON file itself.
+.PP
+If you import a list with no command options, then any new items in
+.I list.json
+are automatically appended to your pre-existing list.  No old items are
+updated, removed, or overwritten.
+.PP
+If you choose \fB--update\fP, then any items which can be found in both
+the original list and
+.I list.json
+will be updated to use the information from whichever has the more recent
+"last_updated" field.
+.PP
+If \fB--overwrite\fP is used, then any items which are present in both
+the original list and
+.I list.json
+are changed to use the information found in
+.I list.json
+\&.
+.PP
+Finally, \fB--overwrite-list\fP will remove everything from the original
+list and use only the information found in
+.I list.json
+(in other words, this will replace the entire list with
+.I list.json
+).
+.RE
+.TP
 show <listname> [\fB-n\fP | \fB--numbered\fP] [\fB--show-headers\fP]
 .RS
 Show the contents of a \fIlistname\fP.
@@ -118,19 +168,24 @@ medialist-cli delete manga
 Deletes the list with name "manga".
 .TP
 medialist-cli delete manga 1
-Deletes the item with ID "1" from the list "manga". As an ID is supplied, the
-list itself isn't deleted.
+Deletes the item with ID "1" from the list "manga". As an ID is supplied,
+the list itself isn't deleted.
 .SH FILES
 .TP
 .I $XDG_CONFIG_HOME/medialist/medialist.conf
 Configuration file for all MediaList programs.
 .SH BUGS
-No known bugs.
+Currently there is no proper way of handling something that you want to
+re-read or re-watch.  So, if you have something that is marked COMPLETE
+(with an end date set), then you change the status to READING/WATCHING,
+only to then change it back to the COMPLETE, the end date will be updated
+again, overwriting the original end date.
 ." .SH "SEE ALSO"
 ." .BR medialist (5).
 .SH COPYRIGHT
-Copyright \(co 2021, 2022 dawning.
+Copyright \(co 2021-2023 dawning.
 .PP
 Copying and distribution of this file, with or without modification, are
-permitted in any medium without royalty provided the copyright notice and this
-notice are preserved. This file is offered as-is, without any warranty.
+permitted in any medium without royalty provided the copyright notice and
+this notice are preserved. This file is offered as-is, without any
+warranty.