From ddec7894853983278e96154d8970a2097594414f Mon Sep 17 00:00:00 2001 From: 85pando <85pando@googlemail.com> Date: Sat, 21 Nov 2015 13:06:10 +0100 Subject: [PATCH 1/4] Add Calibre ebook library tools. --- pages/common/calibre-server.md | 17 +++++++++++++++++ pages/common/calibredb.md | 24 ++++++++++++++++++++++++ pages/common/ebook-convert.md | 8 ++++++++ 3 files changed, 49 insertions(+) create mode 100644 pages/common/calibre-server.md create mode 100644 pages/common/calibredb.md create mode 100644 pages/common/ebook-convert.md diff --git a/pages/common/calibre-server.md b/pages/common/calibre-server.md new file mode 100644 index 000000000..60391d987 --- /dev/null +++ b/pages/common/calibre-server.md @@ -0,0 +1,17 @@ +# calibre-server + +> A server application that can be used to distribute ebooks over a network. +> Ebooks must be imported into the library using the GUI or calibredb before. +> Part of the Calibre ebook library. + +- Start a server to distribute ebooks. Access at http://localhost:8080 + +`calibre-server` + +- Start server on different port. Access at http://localhost:port + +`calibre-server --port {{port}}` + +- Password protect the server. + +`calibre-server --username {{username}} --password {{password}}` diff --git a/pages/common/calibredb.md b/pages/common/calibredb.md new file mode 100644 index 000000000..c38b6f96f --- /dev/null +++ b/pages/common/calibredb.md @@ -0,0 +1,24 @@ +# calibredb + +> Tool to manipulate the your ebook database. +> Part of the Calibre ebook library. + +- List ebooks in the library with additional information. + +`calibredb list` + +- Search for ebooks displaying additional information. + +`calibredb list --search {{search term}}` + +- Search for just ids of ebooks. + +`calibredb search {{search term}} + +- Add one or more ebooks to the library. + +`calibredb add {{file1, file2, …}}` + +- Remove one or more ebooks from the library. You need ebook-ids (see above) + +`calibredb remove {{id1, id2, …}}` diff --git a/pages/common/ebook-convert.md b/pages/common/ebook-convert.md new file mode 100644 index 000000000..9dfd26444 --- /dev/null +++ b/pages/common/ebook-convert.md @@ -0,0 +1,8 @@ +# ebook-convert + +> Can be used to convert ebooks between common formats, e.g., pdf, epub and mobi. +> Part of the Calibre ebook library tool. + +- Convert an ebook into another format. + +`ebook-convert {{source}} {{destination}} From f7bb69881ef53c72a35bdd71116639d234ea536b Mon Sep 17 00:00:00 2001 From: 85pando <85pando@googlemail.com> Date: Sat, 21 Nov 2015 15:51:17 +0100 Subject: [PATCH 2/4] Insert calibre-tools into Index Jason --- pages/index.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/index.json b/pages/index.json index 2b2dd4a4d..df0f5efe2 100644 --- a/pages/index.json +++ b/pages/index.json @@ -1 +1 @@ -{"commands":[{"name":"ab","platform":["common"]},{"name":"ack","platform":["common"]},{"name":"ag","platform":["common"]},{"name":"airport","platform":["osx"]},{"name":"alias","platform":["common"]},{"name":"apropos","platform":["common"]},{"name":"apt-get","platform":["linux"]},{"name":"aptitude","platform":["linux"]},{"name":"ar","platform":["common"]},{"name":"awk","platform":["common"]},{"name":"base64","platform":["linux"]},{"name":"brew","platform":["osx"]},{"name":"bundle","platform":["common"]},{"name":"caffeinate","platform":["osx"]},{"name":"cal","platform":["common"]},{"name":"cat","platform":["common"]},{"name":"cd","platform":["common"]},{"name":"chmod","platform":["common"]},{"name":"chown","platform":["common"]},{"name":"chsh","platform":["common"]},{"name":"cksum","platform":["common"]},{"name":"convert","platform":["common"]},{"name":"cp","platform":["common"]},{"name":"curl","platform":["common"]},{"name":"cut","platform":["common"]},{"name":"date","platform":["common"]},{"name":"deluser","platform":["common"]},{"name":"df","platform":["common"]},{"name":"diff","platform":["common"]},{"name":"dig","platform":["common"]},{"name":"diskutil","platform":["osx"]},{"name":"dpkg","platform":["linux"]},{"name":"drush","platform":["common"]},{"name":"drutil","platform":["osx"]},{"name":"du","platform":["linux","osx"]},{"name":"echo","platform":["common"]},{"name":"electrum","platform":["common"]},{"name":"emerge","platform":["linux"]},{"name":"env","platform":["common"]},{"name":"exiftool","platform":["common"]},{"name":"fdupes","platform":["common"]},{"name":"ffmpeg","platform":["common"]},{"name":"find","platform":["common"]},{"name":"findmnt","platform":["linux"]},{"name":"firewall-cmd","platform":["linux"]},{"name":"free","platform":["linux"]},{"name":"fswebcam","platform":["common"]},{"name":"gcc","platform":["common"]},{"name":"gem","platform":["common"]},{"name":"gifsicle","platform":["common"]},{"name":"git","platform":["common"]},{"name":"git-add","platform":["common"]},{"name":"git-branch","platform":["common"]},{"name":"git-checkout","platform":["common"]},{"name":"git-clone","platform":["common"]},{"name":"git-commit","platform":["common"]},{"name":"git-diff","platform":["common"]},{"name":"git-init","platform":["common"]},{"name":"git-log","platform":["common"]},{"name":"git-merge","platform":["common"]},{"name":"git-push","platform":["common"]},{"name":"git-remote","platform":["common"]},{"name":"git-stash","platform":["common"]},{"name":"git-status","platform":["common"]},{"name":"gpg","platform":["common"]},{"name":"grep","platform":["common"]},{"name":"gzip","platform":["common"]},{"name":"handbrakecli","platform":["common"]},{"name":"haxelib","platform":["common"]},{"name":"head","platform":["linux","osx"]},{"name":"iconv","platform":["common"]},{"name":"iostat","platform":["linux"]},{"name":"ip","platform":["linux"]},{"name":"ipcs","platform":["common"]},{"name":"journalctl","platform":["linux"]},{"name":"kill","platform":["common"]},{"name":"less","platform":["common"]},{"name":"ln","platform":["common"]},{"name":"locate","platform":["linux","osx"]},{"name":"ls","platform":["common"]},{"name":"lsof","platform":["common"]},{"name":"man","platform":["common"]},{"name":"md5","platform":["osx"]},{"name":"md5sum","platform":["linux"]},{"name":"mdadm","platform":["linux"]},{"name":"mkdir","platform":["common"]},{"name":"more","platform":["common"]},{"name":"mount","platform":["common"]},{"name":"mp4box","platform":["common"]},{"name":"mtr","platform":["common"]},{"name":"mv","platform":["common"]},{"name":"mysql","platform":["common"]},{"name":"mysqldump","platform":["common"]},{"name":"nc","platform":["common"]},{"name":"netstat","platform":["linux"]},{"name":"networksetup","platform":["osx"]},{"name":"nmap","platform":["common"]},{"name":"node","platform":["common"]},{"name":"nohup","platform":["common"]},{"name":"npm","platform":["common"]},{"name":"open","platform":["osx"]},{"name":"pacman","platform":["linux"]},{"name":"passwd","platform":["common"]},{"name":"patch","platform":["common"]},{"name":"pbcopy","platform":["osx"]},{"name":"pbpaste","platform":["osx"]},{"name":"pgrep","platform":["common"]},{"name":"php","platform":["common"]},{"name":"ping","platform":["common"]},{"name":"pip","platform":["common"]},{"name":"play","platform":["common"]},{"name":"prctl","platform":["sunos"]},{"name":"prstat","platform":["sunos"]},{"name":"ps","platform":["common"]},{"name":"psql","platform":["common"]},{"name":"pushd","platform":["common"]},{"name":"pwd","platform":["common"]},{"name":"qlmanage","platform":["osx"]},{"name":"redis-cli","platform":["common"]},{"name":"rename","platform":["common"]},{"name":"rm","platform":["common"]},{"name":"rmdir","platform":["common"]},{"name":"route","platform":["osx"]},{"name":"rsync","platform":["common"]},{"name":"salt","platform":["common"]},{"name":"salt-call","platform":["common"]},{"name":"salt-key","platform":["common"]},{"name":"salt-run","platform":["common"]},{"name":"say","platform":["osx"]},{"name":"scp","platform":["common"]},{"name":"screen","platform":["common"]},{"name":"sed","platform":["common"]},{"name":"sha1sum","platform":["linux"]},{"name":"sha224sum","platform":["linux"]},{"name":"sha256sum","platform":["linux"]},{"name":"sha384sum","platform":["linux"]},{"name":"sha512sum","platform":["linux"]},{"name":"shuf","platform":["linux"]},{"name":"shutdown","platform":["linux","osx"]},{"name":"sort","platform":["common"]},{"name":"sox","platform":["common"]},{"name":"split","platform":["common"]},{"name":"srm","platform":["common"]},{"name":"ss","platform":["linux"]},{"name":"ssh","platform":["common"]},{"name":"sshfs","platform":["common"]},{"name":"strace","platform":["linux"]},{"name":"sudo","platform":["common"]},{"name":"svcadm","platform":["sunos"]},{"name":"svccfg","platform":["sunos"]},{"name":"svcs","platform":["sunos"]},{"name":"svn","platform":["common"]},{"name":"sw_vers","platform":["osx"]},{"name":"sysctl","platform":["osx"]},{"name":"system_profiler","platform":["osx"]},{"name":"systemctl","platform":["linux"]},{"name":"systemsetup","platform":["osx"]},{"name":"tail","platform":["common"]},{"name":"tar","platform":["common"]},{"name":"tcpdump","platform":["common"]},{"name":"tcpflow","platform":["linux"]},{"name":"tee","platform":["common"]},{"name":"telnet","platform":["common"]},{"name":"time","platform":["common"]},{"name":"tldr","platform":["common"]},{"name":"tmux","platform":["common"]},{"name":"touch","platform":["common"]},{"name":"tr","platform":["common"]},{"name":"traceroute","platform":["common"]},{"name":"tree","platform":["common"]},{"name":"umount","platform":["common"]},{"name":"uname","platform":["common"]},{"name":"unzip","platform":["common"]},{"name":"useradd","platform":["common"]},{"name":"userdel","platform":["common"]},{"name":"usermod","platform":["common"]},{"name":"wacaw","platform":["osx"]},{"name":"wall","platform":["linux"]},{"name":"watch","platform":["linux"]},{"name":"wc","platform":["common"]},{"name":"wget","platform":["common"]},{"name":"which","platform":["common"]},{"name":"wpa_cli","platform":["linux"]},{"name":"xargs","platform":["linux"]},{"name":"xctool","platform":["osx"]},{"name":"xed","platform":["osx"]},{"name":"xsltproc","platform":["osx"]},{"name":"yes","platform":["common"]},{"name":"zbarimg","platform":["common"]},{"name":"zfs","platform":["common"]},{"name":"zip","platform":["common"]},{"name":"zpool","platform":["common"]}]} \ No newline at end of file +{"commands":[{"name":"ab","platform":["common"]},{"name":"ack","platform":["common"]},{"name":"ag","platform":["common"]},{"name":"airport","platform":["osx"]},{"name":"alias","platform":["common"]},{"name":"apropos","platform":["common"]},{"name":"apt-get","platform":["linux"]},{"name":"aptitude","platform":["linux"]},{"name":"ar","platform":["common"]},{"name":"awk","platform":["common"]},{"name":"base64","platform":["linux"]},{"name":"brew","platform":["osx"]},{"name":"bundle","platform":["common"]},{"name":"caffeinate","platform":["osx"]},{"name":"cal","platform":["common"]},{"name":"calibre-server","platform":["common"]},{"name":"calibredb","platform":["common"]},{"name":"cat","platform":["common"]},{"name":"cd","platform":["common"]},{"name":"chmod","platform":["common"]},{"name":"chown","platform":["common"]},{"name":"chsh","platform":["common"]},{"name":"cksum","platform":["common"]},{"name":"convert","platform":["common"]},{"name":"cp","platform":["common"]},{"name":"curl","platform":["common"]},{"name":"cut","platform":["common"]},{"name":"date","platform":["common"]},{"name":"deluser","platform":["common"]},{"name":"df","platform":["common"]},{"name":"diff","platform":["common"]},{"name":"dig","platform":["common"]},{"name":"diskutil","platform":["osx"]},{"name":"dpkg","platform":["linux"]},{"name":"drush","platform":["common"]},{"name":"drutil","platform":["osx"]},{"name":"du","platform":["linux","osx"]},{"name":"ebook-convert","platform":["common"]},{"name":"echo","platform":["common"]},{"name":"electrum","platform":["common"]},{"name":"emerge","platform":["linux"]},{"name":"env","platform":["common"]},{"name":"exiftool","platform":["common"]},{"name":"fdupes","platform":["common"]},{"name":"ffmpeg","platform":["common"]},{"name":"find","platform":["common"]},{"name":"findmnt","platform":["linux"]},{"name":"firewall-cmd","platform":["linux"]},{"name":"free","platform":["linux"]},{"name":"fswebcam","platform":["common"]},{"name":"gcc","platform":["common"]},{"name":"gem","platform":["common"]},{"name":"gifsicle","platform":["common"]},{"name":"git","platform":["common"]},{"name":"git-add","platform":["common"]},{"name":"git-branch","platform":["common"]},{"name":"git-checkout","platform":["common"]},{"name":"git-clone","platform":["common"]},{"name":"git-commit","platform":["common"]},{"name":"git-diff","platform":["common"]},{"name":"git-init","platform":["common"]},{"name":"git-log","platform":["common"]},{"name":"git-merge","platform":["common"]},{"name":"git-push","platform":["common"]},{"name":"git-remote","platform":["common"]},{"name":"git-stash","platform":["common"]},{"name":"git-status","platform":["common"]},{"name":"gpg","platform":["common"]},{"name":"grep","platform":["common"]},{"name":"gzip","platform":["common"]},{"name":"handbrakecli","platform":["common"]},{"name":"haxelib","platform":["common"]},{"name":"head","platform":["linux","osx"]},{"name":"iconv","platform":["common"]},{"name":"iostat","platform":["linux"]},{"name":"ip","platform":["linux"]},{"name":"ipcs","platform":["common"]},{"name":"journalctl","platform":["linux"]},{"name":"kill","platform":["common"]},{"name":"less","platform":["common"]},{"name":"ln","platform":["common"]},{"name":"locate","platform":["linux","osx"]},{"name":"ls","platform":["common"]},{"name":"lsof","platform":["common"]},{"name":"man","platform":["common"]},{"name":"md5","platform":["osx"]},{"name":"md5sum","platform":["linux"]},{"name":"mdadm","platform":["linux"]},{"name":"mkdir","platform":["common"]},{"name":"more","platform":["common"]},{"name":"mount","platform":["common"]},{"name":"mp4box","platform":["common"]},{"name":"mtr","platform":["common"]},{"name":"mv","platform":["common"]},{"name":"mysql","platform":["common"]},{"name":"mysqldump","platform":["common"]},{"name":"nc","platform":["common"]},{"name":"netstat","platform":["linux"]},{"name":"networksetup","platform":["osx"]},{"name":"nmap","platform":["common"]},{"name":"node","platform":["common"]},{"name":"nohup","platform":["common"]},{"name":"npm","platform":["common"]},{"name":"open","platform":["osx"]},{"name":"pacman","platform":["linux"]},{"name":"passwd","platform":["common"]},{"name":"patch","platform":["common"]},{"name":"pbcopy","platform":["osx"]},{"name":"pbpaste","platform":["osx"]},{"name":"pgrep","platform":["common"]},{"name":"php","platform":["common"]},{"name":"ping","platform":["common"]},{"name":"pip","platform":["common"]},{"name":"play","platform":["common"]},{"name":"prctl","platform":["sunos"]},{"name":"prstat","platform":["sunos"]},{"name":"ps","platform":["common"]},{"name":"psql","platform":["common"]},{"name":"pushd","platform":["common"]},{"name":"pwd","platform":["common"]},{"name":"qlmanage","platform":["osx"]},{"name":"redis-cli","platform":["common"]},{"name":"rename","platform":["common"]},{"name":"rm","platform":["common"]},{"name":"rmdir","platform":["common"]},{"name":"route","platform":["osx"]},{"name":"rsync","platform":["common"]},{"name":"salt","platform":["common"]},{"name":"salt-call","platform":["common"]},{"name":"salt-key","platform":["common"]},{"name":"salt-run","platform":["common"]},{"name":"say","platform":["osx"]},{"name":"scp","platform":["common"]},{"name":"screen","platform":["common"]},{"name":"sed","platform":["common"]},{"name":"sha1sum","platform":["linux"]},{"name":"sha224sum","platform":["linux"]},{"name":"sha256sum","platform":["linux"]},{"name":"sha384sum","platform":["linux"]},{"name":"sha512sum","platform":["linux"]},{"name":"shuf","platform":["linux"]},{"name":"shutdown","platform":["linux","osx"]},{"name":"sort","platform":["common"]},{"name":"sox","platform":["common"]},{"name":"split","platform":["common"]},{"name":"srm","platform":["common"]},{"name":"ss","platform":["linux"]},{"name":"ssh","platform":["common"]},{"name":"sshfs","platform":["common"]},{"name":"strace","platform":["linux"]},{"name":"sudo","platform":["common"]},{"name":"svcadm","platform":["sunos"]},{"name":"svccfg","platform":["sunos"]},{"name":"svcs","platform":["sunos"]},{"name":"svn","platform":["common"]},{"name":"sw_vers","platform":["osx"]},{"name":"sysctl","platform":["osx"]},{"name":"system_profiler","platform":["osx"]},{"name":"systemctl","platform":["linux"]},{"name":"systemsetup","platform":["osx"]},{"name":"tail","platform":["common"]},{"name":"tar","platform":["common"]},{"name":"tcpdump","platform":["common"]},{"name":"tcpflow","platform":["linux"]},{"name":"tee","platform":["common"]},{"name":"telnet","platform":["common"]},{"name":"time","platform":["common"]},{"name":"tldr","platform":["common"]},{"name":"tmux","platform":["common"]},{"name":"touch","platform":["common"]},{"name":"tr","platform":["common"]},{"name":"traceroute","platform":["common"]},{"name":"tree","platform":["common"]},{"name":"umount","platform":["common"]},{"name":"uname","platform":["common"]},{"name":"unzip","platform":["common"]},{"name":"useradd","platform":["common"]},{"name":"userdel","platform":["common"]},{"name":"usermod","platform":["common"]},{"name":"wacaw","platform":["osx"]},{"name":"wall","platform":["linux"]},{"name":"watch","platform":["linux"]},{"name":"wc","platform":["common"]},{"name":"wget","platform":["common"]},{"name":"which","platform":["common"]},{"name":"wpa_cli","platform":["linux"]},{"name":"xargs","platform":["linux"]},{"name":"xctool","platform":["osx"]},{"name":"xed","platform":["osx"]},{"name":"xsltproc","platform":["osx"]},{"name":"yes","platform":["common"]},{"name":"zbarimg","platform":["common"]},{"name":"zfs","platform":["common"]},{"name":"zip","platform":["common"]},{"name":"zpool","platform":["common"]}]} From 9eaaaee4ac03e82ce2269d2c388537f952339c6a Mon Sep 17 00:00:00 2001 From: 85pando <85pando@users.noreply.github.com> Date: Tue, 24 Nov 2015 12:01:45 +0100 Subject: [PATCH 3/4] Update calibredb file/ids are not comma separated --- pages/common/calibredb.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pages/common/calibredb.md b/pages/common/calibredb.md index c38b6f96f..18e5dc11e 100644 --- a/pages/common/calibredb.md +++ b/pages/common/calibredb.md @@ -9,7 +9,7 @@ - Search for ebooks displaying additional information. -`calibredb list --search {{search term}}` +`calibredb list --search {{search-term}}` - Search for just ids of ebooks. @@ -17,8 +17,8 @@ - Add one or more ebooks to the library. -`calibredb add {{file1, file2, …}}` +`calibredb add {{file1 file2 …}}` - Remove one or more ebooks from the library. You need ebook-ids (see above) -`calibredb remove {{id1, id2, …}}` +`calibredb remove {{id1 id2 …}}` From 4dfed291b33148c6c6a4201b555342488f73d0e5 Mon Sep 17 00:00:00 2001 From: 85pando <85pando@googlemail.com> Date: Tue, 24 Nov 2015 14:38:13 +0100 Subject: [PATCH 4/4] Update calibre-tools: missing backticks --- pages/common/calibredb.md | 2 +- pages/common/ebook-convert.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pages/common/calibredb.md b/pages/common/calibredb.md index 18e5dc11e..c17106527 100644 --- a/pages/common/calibredb.md +++ b/pages/common/calibredb.md @@ -13,7 +13,7 @@ - Search for just ids of ebooks. -`calibredb search {{search term}} +`calibredb search {{search term}}` - Add one or more ebooks to the library. diff --git a/pages/common/ebook-convert.md b/pages/common/ebook-convert.md index 9dfd26444..57c3505c9 100644 --- a/pages/common/ebook-convert.md +++ b/pages/common/ebook-convert.md @@ -5,4 +5,4 @@ - Convert an ebook into another format. -`ebook-convert {{source}} {{destination}} +`ebook-convert {{source}} {{destination}}`