From 27eaf84de6c5900c739f73725bd07270d43d49b7 Mon Sep 17 00:00:00 2001
From: Christian Pointner <equinox@helsinki.at>
Date: Sat, 2 Apr 2016 04:50:25 +0200
Subject: improved telnet help text
diff --git a/src/rhimportd/ctrlTelnet.go b/src/rhimportd/ctrlTelnet.go
index 4cbb412..b86965e 100644
--- a/src/rhimportd/ctrlTelnet.go
+++ b/src/rhimportd/ctrlTelnet.go
@@ -58,7 +58,7 @@ func telnetHelp(c *telgo.Client, args []string, conf *rhimport.Config, db *rddb.
c.Sayln(" UserName string username to use for rdxport interface")
c.Sayln(" Password string password to use for rdxport interface")
c.Sayln(" SourceUri string uri to the file to import")
- c.Sayln(" SourceFilePolicy enum values: auto | keep | delete | delete-with-dir")
+ c.Sayln(" SourceFilePolicy enum one of: auto, keep, delete, delete-with-dir")
c.Sayln(" ShowId uint the RHRD show id to import to")
c.Sayln(" ClearShowCarts bool clear all show-carts before importing?")
c.Sayln(" GroupName string name of music-pool group to import to")
@@ -72,28 +72,47 @@ func telnetHelp(c *telgo.Client, args []string, conf *rhimport.Config, db *rddb.
c.Sayln("")
c.Sayln(" UserName, Password and SourceUri are mandatory parameters.")
c.Sayln("")
- c.Sayln(" If ShowId is supplied GroupName, Channels, NomalizationLevel, AutorimLevel,")
+ c.Sayln(" If ShowId is supplied, GroupName, Channels, NomalizationLevel, AutorimLevel,")
c.Sayln(" UseMetaData and Cut will be ignored. The values from the shows' dropbox will")
- c.Sayln(" be used instead. Cart may be specified but must point to an empty cart within")
- c.Sayln(" that show. If ClearCut is true the specified cart will get deleted before")
- c.Sayln(" importing. If Cart is 0 the next free cart in the show will be used. Show")
- c.Sayln(" carts will always be imported into cut 1.")
+ c.Sayln(" be used instead. Cart may be specified but must point to a cart within that")
+ c.Sayln(" show which must be either empty or ClearCart must be set to true. The latter")
+ c.Sayln(" tells rhimportd to delete and recreate the cart before importing. If Cart is")
+ c.Sayln(" set to 0 the next free cart in the show will be used. Show carts will always")
+ c.Sayln(" be imported into cut 1.")
c.Sayln("")
- c.Sayln(" If GroupName is supplied Channels, NomalizationLevel, AutorimLevel,")
- c.Sayln(" UseMetaData, Cut, Cart and ClearCart will be ignored. The values from")
- c.Sayln(" the music pools' dropbox will be used instead. The file will always be")
- c.Sayln(" imported into cut 1 of the first free cart within the music pool.")
+ c.Sayln(" If GroupName is supplied but ShowId is not, Channels, NomalizationLevel,")
+ c.Sayln(" AutorimLevel, UseMetaData, Cut, Cart and ClearCart will be ignored. The")
+ c.Sayln(" values from the music pools' dropbox will be used instead. The file will")
+ c.Sayln(" always be imported into cut 1 of the first free cart within the music pool.")
c.Sayln("")
c.Sayln(" If ShowId and GroupName are omitted a Cart must be specified. Cut may be")
c.Sayln(" supplied in which case both cart and cut must already exist. The import will")
- c.Sayln(" then replace the contents of the current data stored in Cart/Cut. If only Cart")
- c.Sayln(" and no Cut is supplied and ClearCut is false the file will either get imported")
- c.Sayln(" into the next cut of an existing cart or the cart will be created and the file")
- c.Sayln(" will be imported into cut 1 of this cart.")
+ c.Sayln(" then replace the contents of the current data stored in Cart/Cut. If only")
+ c.Sayln(" Cart and no Cut is supplied and ClearCart is false the file will either get")
+ c.Sayln(" imported into the next free cut, in case the cart exists, or the cart will")
+ c.Sayln(" be created and the file will be imported into cut 1 of this cart.")
+ c.Sayln(" If ClearCart is true the cart will be deleted, recreated and the file will")
+ c.Sayln(" be imported into cut 1 of this cart.")
c.Sayln("")
- c.Sayln(" In case of an error carts/cuts which might got created will be removed. Carts")
- c.Sayln(" which got deleted because of ClearShowCarts or ClearCart are however gone for")
- c.Sayln(" good.")
+ c.Sayln(" In case of an error carts and cuts which might got created will be removed.")
+ c.Sayln(" Carts which got deleted because of ClearShowCarts or ClearCart are however")
+ c.Sayln(" gone for good.")
+ c.Sayln("")
+ c.Sayln(" The SourceFilePolicy specifies how to deal with temporary files which might")
+ c.Sayln(" got fetched from remote sources. In 'auto' mode, which is the default, it")
+ c.Sayln(" depends on the fetch uri. Remote fetcher such as http://, archiv://, etc.")
+ c.Sayln(" will create a temporary directory and store the fetched file inside that")
+ c.Sayln(" directory. After the import, successful or not, the file gets deleted. If")
+ c.Sayln(" a local fetcher like tmp:// and local:// are used the file will be left")
+ c.Sayln(" untouched.")
+ c.Sayln(" The 'keep' mode tells rhimportd to leave the file as it is regardless of it")
+ c.Sayln(" being created by rhimportd or not.")
+ c.Sayln(" 'delete' tells rhimportd to delete the file in any case, even if the import")
+ c.Sayln(" has failed or the file was supplied using local://. A directory which might")
+ c.Sayln(" got created by rhimportd will be kept.")
+ c.Sayln(" 'delete-with-dir' also deletes the directory where the source file is in.")
+ c.Sayln(" This might fail if the directory is not empty.")
+ c.Sayln(" ")
return false
case "show":
c.Sayln("usage: show")
--
cgit v0.10.2