ctome
/
tldr
mirror of https://github.com/CrimsonTome/tldr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
2,526 Commits
48 Branches
7 Tags
48 MiB
Commit Graph

1375 Commits (3477ab330ed8da9f3b01c1d4abd15e36f2f83341)

Author SHA1 Message Date
Waldir Pimenta cd31c69479 changes per PR review / capitalization of acronyms 2017-09-17 10:52:39 +05:30
Waldir Pimenta 924c28cb24 mogrify: tweak descriptions 2017-09-17 10:52:39 +05:30
Andrew Louis 415daf8c4b openssl: display a domain's cert's start and end dates (#1486) 2017-09-15 00:26:37 +05:30
Starbeamrainbowlabs c3a4edd934 ansible-galaxy: add page (#1491) 2017-09-14 17:58:04 +01:00
Brandon Soto eb1accac2a ansible-galaxy: update examples 2017-09-13 21:40:12 -07:00
Waldir Pimenta 66e189d221 z: reword descriptions for clarity 2017-09-14 09:58:50 +05:30
Brandon Soto 80d52eb264 ansible-galaxy: fix formatting errors 2017-09-13 20:01:49 -07:00
Brandon Soto 7b72852a88 ansible-galaxy: add page 2017-09-13 19:57:24 -07:00
Starbeamrainbowlabs 1c0131f594 groff: add page (#1478) 2017-09-10 20:13:52 +01:00
Starbeamrainbowlabs b501224e31 vault: add page (#1475) 2017-09-09 17:13:33 +01:00
Waldir Pimenta a11869186c moro: minor tweaks (#1470) 2017-09-09 12:50:41 +00:00
Waldir Pimenta dee7890231 Update groff.md 2017-09-09 12:52:54 +01:00
Waldir Pimenta d6330e2107 groff: create page 
Sources: https://embswit.wordpress.com/2013/02/08/render-man-page-from-source/, and the EXAMPLES section of `man groff` :)
 2017-09-08 17:06:21 +01:00
Jeroen Meulemeester 0ddfb4fcf1 vault: Fix punctuation review remarks 2017-09-08 16:36:06 +02:00
Jeroen Meulemeester 98ccb02551 vault: Simplify examples and prevent jargon 
- Simplified 'init' command, using the defaults
  - Provide synonym 'unlock' to explain the 'unsealing' process
  - Use 'key shares' instead of 'key-shares' or 'keyshares'
  - Briefly explain what 'sealing' means
 2017-09-08 14:21:37 +02:00
Waldir Pimenta 7b3bb72fba mailx: fix keyboard shortcut format, per #1354 2017-09-08 10:01:07 +01:00
Jeroen Meulemeester 8e75c50172 vault: Fix 'comma/comment' remarks 2017-09-08 07:40:26 +02:00
Waldir Pimenta d61bfa85c6 pssh: improve page (#1466) 2017-09-08 04:13:59 +00:00
Jeroen Meulemeester 3074e54c5d vault: Fix 'vault write' remarks 
Vault uses different back-ends (secret, auth, audit, ..), which are
modeled as a kind of file system:

  - Remove 'secret' from the token
  - Include the 'secret' back-end to the 'vault write' description
 2017-09-07 21:39:50 +02:00
Jeroen Meulemeester 2ae4673c9d vault: Fix some review remarks 2017-09-07 18:50:18 +02:00
Jeroen Meulemeester f10ea81e3e vault: add page 2017-09-07 18:35:24 +02:00
Waldir Pimenta 802eb6c5af peerflix: expand based on official docs 
- add a torrent url example
- add the --list and --subtitles options
- make the magnet link example more realistic:
  BitTorrent info hashes (BTIH) are hex-encoded SHA-1 hash sums of the "info" sections of BitTorrent metafiles;
  SHA-1 hash values are typically rendered as a hexadecimal number, 40 digits long.
- replace "your favorite player" with "a media player" in the main description
- clarify which files from the torrent will be streamed in each case
 2017-09-01 08:09:33 -01:00
David Aerne d9136fd564 peerflix: adds page (#1457) 2017-08-31 19:13:56 +00:00
Pavel Tarnopolsky ed81078a21 docker-compose: add page (#1460) 2017-08-31 09:55:23 +01:00
Waldir Pimenta d894e77b83 duplicity: various tweaks (#1452) 2017-08-31 09:49:40 +01:00
jasonxia23 563ccc9b2a gist: add two examples (#1453) 2017-08-25 12:53:33 +01:00
Eric Sirianni 91d54f868e git-diff: add cross-branch diff example (#1454) 2017-08-25 12:42:05 +01:00
Waldir Pimenta bad0110e8a xmllint: various fixes (#1450) 
- fix string example, and improve its description
- move xpath information to the main description
- add "tags" synonym for "nodes"
- add a html example
- simplify description of doctype example
- capitalize "xml" consistently
 2017-08-25 08:09:36 -01:00
wefhy 024b2107ae mogrify: add page (#1447) 2017-08-20 17:37:03 +00:00
Starbeamrainbowlabs 2ff018202b duplicity: add page (#1443) 2017-08-19 12:15:09 +00:00
zlbabe d86e7e35a2 lsof: list opened files in a directory (#1449) 2017-08-17 12:08:23 +00:00
Ran Yitzhaki 3cc612800e z.md: add page (#1442) 2017-08-10 18:50:04 +01:00
Omid Hezaveh 6f55ac0dec moro: add page (#1441) 2017-08-09 20:17:54 +01:00
HairyFotr e0ccb7147a Fix a few typos 2017-07-23 19:52:44 +05:30
haydenbetts 0d9a445e2f xmllint: add page (#1425) 2017-07-14 09:36:12 +01:00
Dan Kim bf8cdbee45 pssh: add page (#1422) 2017-07-11 23:32:25 +05:30
Agniva De Sarker a5cd2a7dc7 xxd: add page (#1424) 2017-07-06 17:26:44 +01:00
Starbeamrainbowlabs 13a86805d9 sqlite3: add page (#1420) 2017-07-03 12:41:36 +01:00
Waldir Pimenta b6d84a6b42 bg: clarify descriptions (#1416) 2017-06-26 12:56:56 +01:00
Waldir Pimenta 04fad240fe curl: remove -I from auth example (fixes #1406) (#1417) 
(also, minor tweaks to some of the descriptions)
 2017-06-26 06:13:01 -04:00
Andrew Prentice 58826bfdab ffprobe: add page (#1414) 2017-06-23 19:04:48 +01:00
Waldir Pimenta ec794ec2dc umount: make descriptions more explicit (#1408) 
* umount: make descriptions more explicit

* umount: clarify main description, per PR disc.
 2017-06-23 11:17:00 +01:00
luk3yx 0fbce892d8 sshpass: remove unmatched quote mark (#1413) 2017-06-18 23:27:11 +01:00
luk3yx f507c81857 sshpass: add page (#1411) 2017-06-18 20:12:00 +01:00
Waldir Pimenta 87fb4e13bd git-config: overhaul page (#1402) 
- expand description of local and global options
- adjust example descriptions for clarity
- change the descriptions of the get/set/remove examples to be more generic 
- change the alias example to a more useful one
- use "configuration entries" instead of "configuration options" to match both preset options and aliases
 2017-06-15 23:30:21 +01:00
Alexey B dea97777c4 7z: fix example of -t option (#1405) 2017-06-15 12:21:34 +01:00
Gabriel Totev bf37b88bab valgrind: add page (#1407) 
* valgrind: add page

* valgrind: tweak Memcheck example

Provide alternate, clearer syntax that functions the same and update
description accordingly.

* valgrind: correct program description

* valgrind: add list of common tools

* valgrind: remove general form example and add no-option example

* valgrind: replace period with colon in example 1
 2017-06-12 13:07:22 +01:00
Starbeamrainbowlabs 10e9f9d2af badblocks: add page (#1399) 2017-06-11 14:30:40 +01:00
Gabriel Totev 1d2cbd0f07 nasm: add page (#1401) 2017-06-10 00:03:16 +01:00
Waldir Pimenta 5085853d51 fping: a IP --> an IP 2017-06-09 22:50:23 +01:00
Max Xu 4bbb5c8876 fping: add page (#1395) 2017-06-08 15:55:51 +05:30
Waldir Pimenta b4dc9ec224 cmake: use -H -B trick for out-of-src build 
As initially discussed in #1379. This removes the need to use `mkdir` and `cd`. Inspired by this post:
https://www.reddit.com/r/programming/comments/6b9r19/how_to_build_a_cmakebased_project/dhlfh05/
 2017-06-08 09:54:38 +05:30
Starbeamrainbowlabs 03d1622cfc Add multithreading example (#1398) 2017-06-06 19:56:14 +01:00
Zhou Fangyi 5a17e68729 curl: add separate entry for header & HTTP method; clarify entry for JSON (#1396) 2017-06-06 08:23:00 +01:00
Thales Mello efedbb2835 gist: add page (#1389) 
* Include gist page

* Fix linting errors

* Quote "hello world" in the echo commnad

* Change wording to make explanation clearer

* Further simplify descriptions of gist command

* Simplify description of the update gist command
 2017-05-29 16:02:09 +01:00
Starbeamrainbowlabs 4c2cd7ecf9 keepass2: add page (#1394) 2017-05-29 00:58:29 +05:30
David Haynes 5ea8b54d90 hugo: omit subject 
- Remove uses of "your" and "you"
 2017-05-26 20:02:52 +05:30
David Haynes 474f188b88 hugo: modify language 
- hugo -> Hugo
- lowercase the description
- plain URL
- remove the extension token
- do not use relative references
- modify the buildDraft example to standalone and change the wording slightly
- modify the "watch for changes" wording slightly
 2017-05-26 20:02:52 +05:30
David Haynes 0dea4539f3 hugo: add page 
- Add in `hugo` commands essential to getting a site up and running.
- This is defined as:
    - A site existing
    - A theme existing
    - A page existing
    - The site being built in some manner (optionally being served through the webserver)

First pass on verbage.
 2017-05-26 20:02:52 +05:30
Waldir Pimenta e92592cc2c cowsay: remove redundant text in main description 2017-05-26 13:39:10 +01:00
Noah Overcash 834eefb2d5 cowsay: add listing command 2017-05-26 13:39:10 +01:00
Starbeamrainbowlabs a50427e89f mktemp.md: add page (#1393) 2017-05-26 10:28:13 +01:00
Starbeamrainbowlabs 497a561ae1 Update quota.md 2017-05-24 09:32:16 +01:00
kalebo d0ebfa44a5 Tweaked quota example 2017-05-24 09:32:16 +01:00
Vivek Krishnakumar db766044de mosh: add page (#1384) 2017-05-24 12:03:32 +05:30
Waldir Pimenta 6b1e4f24ab cmake: add mkdir to the out-of-source build ex. 2017-05-22 20:41:16 +01:00
Waldir Pimenta 08da564f80 mutt: add reference to draft format 
as discussed in PR #1258
 2017-05-22 16:43:10 +01:00
Waldir Pimenta efbf0cc51e perl: tweak the -0 example 2017-05-22 19:47:03 +05:30
Waldir Pimenta dc9547925f perl: swap -M example with -0, for multiline regex 
For completeness: the -0 option is actually used to specify the input record separator (as an octal number).
Without it, the record separator is the newline character, i.e. the files are processed line by line
(which doesn't allow find-replace expressions that include newlines to work).

According to the [documentation](http://perldoc.perl.org/perlrun.html#Command-Switches),
using plain `-0` is not guaranteed to have the effect of parsing the entire file,
because if the file does contain characters with octal value equal to the parameter passed to (or implied by) the -0 option,
these characters will be treated as line breaks.
However, if the value exceeds 377<sub>8</sub> (i.e. 255), it won't be matched to characters on the file.
777 is the preferred convention within that exceptional range, as the highest value that keeps to 3 octal digits.

Here we're forgoing such details and using -0 anyway, since for most cases this will be enough.
 2017-05-22 19:47:03 +05:30
bigspennyj 04ecf81efc mutt: add page (#1258) 2017-05-22 11:52:55 +05:30
Starbeamrainbowlabs ca3ee12c17 prosodyctl: add page (#1382) 2017-05-19 13:33:25 +05:30
Starbeamrainbowlabs 93348478a1 lua: add page (#1381) 2017-05-19 08:47:18 +01:00
Waldir Pimenta 595c4eb234 git-reset: add simpler --hard example 2017-05-18 17:25:09 +01:00
Waldir Pimenta 05780d6183 git-checkout: "modifications" --> "changes" 2017-05-18 17:24:52 +01:00
Waldir Pimenta 6f9dbe9fce git-checkout: mention reset, add single-file ex. 2017-05-18 17:24:52 +01:00
Waldir Pimenta 88eea86117 cmake: directory --> folder; fix typo 2017-05-16 11:37:47 +01:00
Damian Peterson 1ceb440ea4 vimdiff: add page (#1373) 2017-05-14 21:27:16 +01:00
Wolfgang Lutz 550ede5cfb fix typos using misspell (#1374) 2017-05-12 10:29:18 +01:00
Starbeamrainbowlabs c0616697ed jpegoptim: add page (#1370) 
* New command: jpegoptim

* Update jpegoptim.md
 2017-05-10 20:46:18 +01:00
Waldir Pimenta c9063d15b9 telnet: improve descriptions (#1353) 
* telnet: improve descriptions

also format "x" as a token in the last example.

* telnet: update per code review
 2017-05-04 20:50:30 +01:00
Waldir Pimenta 7ca686634d jq: clarify descriptions (#1361) 2017-05-04 09:35:38 +01:00
Waldir Pimenta 776fdcf77a cmake: fix syntax and adjust per code review 2017-05-04 08:46:54 +01:00
PFCKrutonium d3fed3b31f cmake: add page (closes #1172) 2017-05-04 08:46:54 +01:00
Waldir Pimenta 7a9c755e4e pygmentize: various tweaks (#1355) 
* pygmentize: various tweaks

- adjust punctuation in main description and first example's description
- mention "list" (rather than "show") in the -L examples, to improve memorability
- explain what lexers are
- clarify which of the parameters are input and output filenames
- simplify last example

* make -O example more didactic

References:
- http://pygments.org/docs/cmdline/#options-and-filters
- http://pygments.org/docs/formatters/#HtmlFormatter

* pygmentize: changes per code review

* pygentize: fix typos
 2017-05-03 20:54:49 +01:00
Waldir Pimenta 97265cba29 cal: move from pages/common/ to pages/osx/, so the content corresponds to the command version 2017-05-02 08:10:49 +01:00
Waldir Pimenta b893232f48 yesod: tweak main description (#1362) 2017-05-01 20:11:23 +01:00
Waldir Pimenta 85212343a0 timew: tweaks to descriptions 2017-05-01 15:00:12 +01:00
Waldir Pimenta 3b0cf23bac pm2: add article in last two examples 2017-05-01 11:16:05 +01:00
Moti Korets 2f03bc1362 at: add page, atq: add page, atrm: add page, and batch: add page (#1344) 
commands to queue commands execution at specified time
or when system load allows
 2017-05-01 11:06:06 +01:00
Waldir Pimenta 2a4379ceea git-checkout: correct checkout of remote branch (#1359) 
As described in http://stackoverflow.com/a/9537923 (paraphrased below):

> You need to create a local branch that tracks a remote branch.
> The following command will create a local branch
> tracking the remote branch of the same name.
> When you push your changes the remote branch will be updated.
>
> `git checkout --track [remotename]/[branch]`
>
> This is a shorthand for `git checkout -b [branch] [remotename]/[branch]`.
>
> For git 1.7.2.3 and higher this is enough: `git checkout daves_branch`
>
> Note that with recent git versions,
> **this will command not create a local branch and will put you in a 'detached HEAD' state.**
> If you want a local branch, use the --track option.
> Full details here: http://git-scm.com/book/en/v2/Git-Branching-Remote-Branches#Tracking-Branches
 2017-04-30 11:17:03 +01:00
Waldir Pimenta 433370e2ad change all keyboard shortcuts to have spaces around the + sign (#1356) 2017-04-28 23:34:51 +01:00
Waldir Pimenta 7e1f06ade4 standardize format of keyboard shortcuts (#1354) 
* fix capitalization of keyboard shortcuts (elinks, tmux, screen)
* adjust formatting of keyboard shortcuts (tail, xsel)
 2017-04-28 08:44:50 +01:00
Waldir Pimenta 81c7f52e9f wordgrinder: minor tweaks to descriptions 2017-04-28 08:33:05 +01:00
Agniva De Sarker 9af9eee235 minor update 
adding a space after comma
 2017-04-28 08:28:19 +01:00
Rudinski Zvonimir 4a0662a95e minor changes 2017-04-28 08:28:19 +01:00
Agniva De Sarker e9a443b189 simplify wordgrinder 
- Removing the word terminal because its implicit
- Mentioning that it loads a blank document by default
- Removing 'press' to maintain uniformity with other pages like `rtv`
 2017-04-28 08:28:19 +01:00
Agniva De Sarker d49b95fc53 Simplify pygmentize 
- Simplify main description
- Mentioning that language is inferred from file extension
- Giving a concrete example for another lexer.
 2017-04-28 08:28:19 +01:00
Agniva De Sarker 5c278bdf69 Update mc.md 
- Usually, we do not use another command in the example of one command's description.
- Using the second line of the heading to explain further.
 2017-04-28 08:28:19 +01:00
Zvonimir Rudinski 053d8dbeb0 linter fixes 2017-04-28 08:28:19 +01:00
Rudinski Zvonimir 7d360fface add pygmentize 2017-04-28 08:28:19 +01:00