diff --git a/doc/lktadm.1 b/doc/lktadm.1 index 1198c94cadbc7c11ee4b1a9f8176ac4da2e04af4..f7309e8b9180698700a7f169fd75555b76c59b03 100644 --- a/doc/lktadm.1 +++ b/doc/lktadm.1 @@ -1,6 +1,11 @@ .SH "NAME" lktadm \- the lektor administration tool .SH "OVERVIEW" +Commands can be used with the minimal name that permit them to be +distinguished from others commands. Thus, it is possible to use the +string \fIdow\fP as an alias for \fIdownload\fP. This is like cisco switch +command line interface. +.PP You may be interested in other related programs like: .PP .PD 0 @@ -10,3 +15,50 @@ You may be interested in other related programs like: \fIlkt\fP A standard client for lektord .PD +.SH "COMMANDS" +Here are the \fBlkt\fP commands: + +.PP +\fIBASE-COMMANDS\fP +.PP +.PD 0 +.TP +.PD +\fBget\fP <id> +Get and display the metadata of a kara by its id. You must have access to +the \fIKurisu\fP repo +.TP +\fBdownload\fP <id> <filepath> +Download a kara from kurisu and save it to the specified path +.TP +\fBcat\fP <filepath> +Display the metadata of a kara specified by the its path +.TP +\fBconf\fP +Prints the default configuration file to stdout + +.PP +\fIINITIALISATION-COMMANDS\fP +.PP +.PD 0 +.TP +.PD +\fBinit database\fP +Create the empty database with the correct SQL schema. You need a valid +configuration file to do that +.TP +\fBinit populate\fP +Populate the database with kara on the filesystem. You need a valid +configuration file and a valid database for that +.TP +\fBinit metadata\fP +Write the correct metadata to kara in the filesystem. For that you +need a valid configuration file and a specific organisation of the files. +The best way of doing it is using the \fIadmin update\fP command with +\fBlkt\fP. This command is present but depracted +.TP +\fBinit file\fP +Write correct metadata to a kara in the filesystem. You need a specific +file organisation for that command to work. It is depracted but present +for debuging purpose +.PP