Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

calibredb, calibre-server, ebook-convert: add pages #326

Merged
merged 4 commits into from
Nov 24, 2015
Merged

calibredb, calibre-server, ebook-convert: add pages #326

merged 4 commits into from
Nov 24, 2015

Conversation

85pando
Copy link
Contributor

@85pando 85pando commented Nov 21, 2015

Calibre is a program to manage your ebook library. It has several usefull command-line tools.

@lord63
Copy link
Contributor

lord63 commented Nov 21, 2015

Don't forget to update the index.json

@igorshubovych
Copy link
Collaborator

@rprieto,

I noticed there are 2 different ways of listing multiple related arguments.

In this and some other pages several arguments are listed in one token:
calibredb add {{file1, file2, …}}
zip -r {{compressed.zip}} {{/path/to/dir1 /path/to/dir2 /path/to/file}}

On other pages arguments are listed one by one,
diff {{file1}} {{file2}}
zpool create {{poolname}} mirror {{disk1}} {{disk2}}

What is the preferred way?

@85pando
Copy link
Contributor Author

85pando commented Nov 24, 2015

Given this comment from rprieto i think it is clear it should be one command per example.

@igorshubovych
Copy link
Collaborator

This commit has one command per example as it is mentioned in Contributing guidelines.

My question was regarding the way tokens are listed in a single example.

command {{file1, file2}}

vs

command {{file1}} {{file2}}

@85pando
Copy link
Contributor Author

85pando commented Nov 24, 2015

Sorry, too early (-;

User-provided values should use the {{token}} syntax, to allow clients to highlight them. For example: tar cf {{file}}

So in my understanding, the token is just needed for highlighting values. For the diff example at least that is a different case, as both values are needed. In calibredb add you need one file but more files are possible.

- Search for just ids of ebooks.

`calibredb search {{search term}}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a missing backtick here

igorshubovych added a commit that referenced this pull request Nov 24, 2015
Add Calibre (calibredb, calibre-server, ebook-convert)
@igorshubovych igorshubovych merged commit e486167 into tldr-pages:master Nov 24, 2015
@igorshubovych
Copy link
Collaborator

@rprieto,

Can we automate checking missing backticks?

@85pando 85pando deleted the calibre branch November 24, 2015 15:01
@waldyrious waldyrious added the new command Issues requesting creation of a new page or PRs adding a new page for a command. label Sep 8, 2016
@waldyrious waldyrious changed the title Add Calibre calibredb, calibre-server, ebook-convert: add pages Sep 28, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page or PRs adding a new page for a command.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants