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

1785 Commits (91938046f20a336c4383af6f8af1f54d2ad9324b)

Author SHA1 Message Date
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
Waldir Pimenta 1de00d2f11 brew cask: add page (#1376) 2017-05-22 14:49:40 +01:00
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
Starbeamrainbowlabs 1ff585c6fd New command: calc (#1380) 2017-05-18 23:34:36 +05:30
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 9fbc74e1de lxc: add page (#1371) 2017-05-16 10:42:11 +05:30
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
Starbeamrainbowlabs 8125f34ee7 New command: hostnamectl 2017-05-07 17:11:41 +05:30
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
Starbeamrainbowlabs e8d141b6c4 whatis: add glob example (#1365) 2017-05-04 08:38:06 +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 f7b60eb9c6 pvcreate: tweaks to descriptions (#1336) 2017-05-02 13:48:58 +01:00
Waldir Pimenta b3654135a8 cal: adjust osx version to make it more useful, and add linux version along the same lines 2017-05-02 08:10: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 d6e709fd3d imgcat: slight rephrase of main desc 2017-05-02 12:38:18 +05:30
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
Rudinski Zvonimir 6ae8e8761a Added pages for mc, tpp and wordgrinder 2017-04-28 08:28:19 +01:00
Waldir Pimenta 2a359234ba elinks: minor tweaks to command descriptions 2017-04-28 00:01:06 +01:00
Waldir Pimenta 13539295a4 elinks: fix typo (confusion of ANSI vs. ASCII) 2017-04-27 23:59:42 +01:00
Waldir Pimenta 45d9ef5b6a docker: minor tweak to first description 
change "List" from a noun to a verb, to match the project's guidelines.
 2017-04-27 23:55:32 +01:00
Waldir Pimenta 724ec3d5de wrap 100 in token format; mention password prompt 2017-04-27 11:04:54 +05:30
Waldir Pimenta 8241783af1 tomb: fix syntax to match guidelines 2017-04-27 11:04:54 +05:30
Waldir Pimenta 0c602a263f tomb: edit page to conform to tldr guidelines 
also improve example descriptions to better match the documentation in https://www.dyne.org/software/tomb and http://tomb.dyne.org/tomb_manpage.pdf
 2017-04-27 11:04:54 +05:30
Michishige Kaito c0d16b2f7e Fix lint issues. 2017-04-27 11:04:54 +05:30
Michishige Kaito 972e5889e1 tomb: add page 2017-04-27 11:04:54 +05:30
Waldir Pimenta fb7e3969fe wuzz: add primary command; de-capitalize descs 2017-04-26 13:06:27 +01:00
Agniva De Sarker 331c97b209 wrapping some items in tokens 2017-04-26 13:06:01 +01:00
Waldir Pimenta 4da1c1c3df git-rebase: improve desc of second -i example 2017-04-26 13:06:01 +01:00
Waldir Pimenta e8dd7e0b57 rephrase --onto example; add in-place rebase 2017-04-26 13:06:01 +01:00
Waldir Pimenta 8f18647c82 git-rebase: hopefully clarify some points 2017-04-26 13:06:01 +01:00
Waldir Pimenta c3146ede2a perl: improve descriptions of -pie examples 2017-04-26 10:32:58 +01:00
morrme 8b85207f35 perl: add pie example per issue #1239 2017-04-26 10:32:58 +01:00
Waldir Pimenta cd38a006d8 find: slightly reword the -not -path example 2017-04-25 22:50:51 +01:00
Waldir Pimenta d236ec5007 xeyes: minor rewording for clarity 2017-04-24 12:29:26 +05:30
Vanesssa a3a2206b6d n: add page (#1319) 2017-04-24 10:07:58 +05:30
Angelos Orfanakos 80bb512491 apt: add missing sudo to examples 2017-04-23 21:55:19 +01:00
Angelos Orfanakos 1516784640 apt: remove full-upgrade example 
It's rarely used and beyond the scope of tldr
 2017-04-23 21:55:19 +01:00
Angelos Orfanakos 73d3ddabc1 apt: add show example 2017-04-23 21:55:19 +01:00
Angelos Orfanakos fd6104b290 apt: remove invalid autoremove example 
There is no autoremove command
 2017-04-23 21:55:19 +01:00
Waldir Pimenta 6fc1a2234b carthage: description tweaks 2017-04-23 19:55:45 +05:30
abactel 1e15c9cad3 timew: add page (#1343) 
timew: add page
 2017-04-23 10:22:15 +01:00
Waldir Pimenta 69c12013b3 lsof: shorten main desc, expand PID acronym (#1346) 2017-04-22 19:44:03 +01:00
Waldir Pimenta 777073fcb8 id3tag: minor tweaks (#1347) 2017-04-22 14:37:16 +01:00
Waldir Pimenta df46736db7 git-imerge: add "abort" example (#1339) 2017-04-21 10:45:54 +01:00
Waldir Pimenta 9475cd3589 git-clean: fix verb tense 2017-04-21 00:33:36 +05:30
Eliot Sykes 4d80ebdc16 Typo fix. Simplify git exclude path. 2017-04-21 00:33:36 +05:30
Eliot Sykes 100320e3a6 Add git clean -f, -x options 2017-04-21 00:33:36 +05:30
Eliot Sykes 18b9f11a29 git-clean: add page 2017-04-21 00:33:36 +05:30
Starbeamrainbowlabs 3f53e3282f composer: add page (#1329) 2017-04-20 16:57:57 +05:30
Waldir Pimenta 5cb62ebbff git-show: various tweaks (#1341) 
- adjust punctuation & spacing in main description
- adjust descriptions ("changes" --> "information", and explicitly list which info is returned in the first example)
- use a concrete example for the tilde notation
- add abbreviated example
 2017-04-19 21:25:28 +01:00
Waldir Pimenta 01a9717bc9 curl: tweak desc of last example, per code review 2017-04-19 19:30:33 +01:00
Waldir Pimenta e6a54d891a curl: remove secure/insecure ambiguity 2017-04-19 19:30:33 +01:00
Waldir Pimenta b051c298d0 curl: spell out the --insecure option 2017-04-19 19:30:33 +01:00
Waldir Pimenta 3acc0d64b8 curl: simplify last example (#1246) 2017-04-19 19:30:33 +01:00
Waldir Pimenta 7329c7275f adduser: change token from "name" to "username" 2017-04-19 15:16:08 +05:30
Agniva De Sarker 9fd6e9cf11 cp: fix travis error 2017-04-19 10:20:18 +01:00
Waldir Pimenta c3d4b4ac55 cp: phrase -i option the same way as the -v option 2017-04-19 10:20:18 +01:00
Waldir Pimenta faed93cbae cp: remove leading / from paths; add -i example 2017-04-19 10:20:18 +01:00
Waldir Pimenta 00656cd8c4 cp: remove shell expansion examples, add -r 2017-04-19 10:20:18 +01:00
Waldir Pimenta da10202a3d cp.md: major overhaul 
- change "directory" to "folder" (more beginner-friendly)
- use an extension to distinguish file paths from folder paths
- reword some of the descriptions for clarity
- include examples to clarify when the target argument defines the actual copy, and when it defines the folder where to put the copy
- add an example to copy contents of a folder into another (existing) folder
 2017-04-19 10:20:18 +01:00
Waldir Pimenta b865b392c4 vgcreate: improvements to descriptions (#1335) 2017-04-19 10:11:57 +01:00
Waldir Pimenta e59d19a00d cowsay: minor adjustment to main desc. 2017-04-18 22:20:43 +01:00
alefir b71c9cdcf3 git-show: add page (#1331) 2017-04-18 22:39:07 +05:30
Matt Terwilliger 11e745572e Recursive scp arguments reversed (#1321) 
* Recursive scp arguments reversed

The command to "copy [...] on a remote host to a local
directory" in the current scp tldr page was backwards.

scp arguments take the form `scp from to`.

* add the word from for clarity
 2017-04-18 09:07:46 -04:00
Waldir Pimenta 8493ee06ba cowsay: remove overly complex example, reword desc (#1323) 2017-04-18 09:06:20 -04:00
Waldir Pimenta c644c19a8c x11vnc: wording tweaks (#1324) 
* x11vnc: wording tweaks

* x11vnc: clarify monitor vs. display vs. screen

See http://stackoverflow.com/a/1210332 and https://en.wikipedia.org/wiki/X_Window_System#Nomenclature
 2017-04-18 09:04:53 -04:00
Waldir Pimenta aa22af277a od: overall copyedit 
- reworded command description
- reworded example descriptions for clarity and explicitness
- changed order and content of examples, to introduce options gradually
- formatted all user-selectable parts (option values and arguments) in the token markup
 2017-04-18 10:24:50 +05:30
Yuri Slobodyanyuk 8b79edda0c Update od.md 
yet another fix
 2017-04-18 10:24:50 +05:30
Yuri Slobodyanyuk aa9d4d5887 Update od.md 
still more fixes
 2017-04-18 10:24:50 +05:30
yuri-sk aface6c32d Update od.md 2017-04-18 10:24:50 +05:30
yuri-sk 25a9bc4ae4 Update od.md 
Fixed
 2017-04-18 10:24:50 +05:30
yuri-sk de1d5b05fa Add odd command to the common 
Not much to comment - https://linux.die.net/man/1/od
Thanks
 2017-04-18 10:24:50 +05:30
Waldir Pimenta 1fcc48e01a mailx: various tweaks 
- restore "content" as opposed to "body", per PR discussion
- various improvements to command descriptions
 2017-04-17 10:54:29 +05:30
Starbeamrainbowlabs 092294370d mailx: Improve the readability of the descriptions 2017-04-17 10:54:29 +05:30
Waldir Pimenta 55517e7d39 eyeD3: reorder examples, capitalize MP3 
I think this order of the examples better matches a progression in complexity
 2017-04-15 13:10:54 +01:00
Agniva De Sarker d2d374297a eyeD3: improve main description 2017-04-15 13:10:54 +01:00
Starbeamrainbowlabs 70d95676d4 eyeD3: add page 2017-04-15 13:10:54 +01:00
Waldir Pimenta 292825cfe7 zramctl: minor capitalization / punctuation tweaks 2017-04-15 12:48:03 +01:00
Jeef fdfa144cb0 tput: add two examples (#1299) 2017-04-15 12:29:28 +01:00
Waldir Pimenta 952eca58e8 tesseract: minor tweak to the first example's desc 2017-04-15 12:18:50 +01:00
Waldir Pimenta d3f01ac91c nl: adjustments per code review 2017-04-15 11:37:03 +01:00
PFCKrutonium 60ebf37f35 nl: add page (fixes #1163) 2017-04-15 11:37:03 +01:00
Waldir Pimenta 16969bf3dc import: minor tweaks (#1322) 2017-04-15 10:02:09 +01:00
Waldir Pimenta f12a12b792 svgo: add page (#1061) 2017-04-15 09:52:17 +01:00
morrme b69c14b404 curl: improve last example per issue #1246 (#1326) 2017-04-15 09:49:12 +01:00
Waldir Pimenta 09837acac5 xdotool: fix typo 2017-04-14 23:08:36 +01:00
Jade Thornton 8dbc49c36b killall: add page (#1317) 2017-04-09 22:11:36 +05:30
Starbeamrainbowlabs 9059d62b22 zramctl: add page (#1307) 2017-04-07 08:56:00 +05:30
Rogelio Cedillo 6d5f467512 lvcreate: add page (#1270) 
* lvcreate: add page

* fix lint errors

* adding short description of volume group

* Simplify volume group description
 2017-04-06 07:42:26 -04:00
Ismail Arafa ece6982be9 Create browser-sync.md (#1287) 2017-04-06 07:41:22 -04:00
Vincent Yang 7fd90b1d58 pm2: add page (#1306) 
* pm2: add page

* Make Travis happy

* Added pm2 restart

* Simplifying examples

* Fixed typo
 2017-04-06 07:40:06 -04:00
Justin Kenyon 3a858a93af Update grammar 
`a` should be used instead of `an` in this context.
 2017-04-03 20:30:15 +05:30
Jon LaBelle 7549db275b id3tag: Trim trailing whitespace in first example 2017-03-26 23:46:23 +05:30
Daniel Senff 3276058ed9 id3tag.md: add page (#1280) 2017-03-25 12:06:30 +05:30
Jeef b62fb5377a imgcat: add page (#1283) 2017-03-24 09:32:58 +05:30
Daniel Campoverde a409df6f28 yesod: add page (#1302) 2017-03-23 09:37:05 +05:30
Jeef 3f1a853c93 Update elinks.md 2017-03-17 21:43:44 +05:30
Jeef 6396235a1c Create elinks.md 2017-03-17 21:43:44 +05:30
Sébastien Wains da09e78bc7 mpstat: add page (#1301) 
* mpstat: add page

* Update mpstat

- Incrementally added options
- Simplified the descriptions
- Tokenified the values
 2017-03-17 09:52:06 -04:00
Jeef 7103d8fa31 docker: added rm command (#1297) 2017-03-16 10:07:17 +05:30
Xiang Wang 4626735021 find: ignore given directory (#1289) 
* find path while excluding certain directory

* delete the `find {{root_path}} -empty` command to meet the demand of 8 commands at most

* tokenize the demo parameter
 2017-03-10 09:48:29 -05:00
Jeef 7ced4bbeeb Merge pull request #1288 from YangVincent/master 
wuzz: add page
 2017-03-10 09:46:01 -05:00
Jeef d5f7715879 vncserver: Add page (#1290) 2017-03-10 10:20:47 +05:30
Alfred Bez cd29c9775f mtime argument (find command) expect numeric value 2017-03-10 10:13:34 +05:30
Jeff Stein 79d02ceaf2 added the showfigfonts command 2017-03-09 23:38:21 +05:30
Jeef 3ac4ed9216 Merge pull request #1292 from Risen-phoenix/master 
hangups: add page
 2017-03-09 09:44:40 -05:00
Risen-phoenix e8623030f1 Update hangups.md 2017-03-08 11:21:17 -05:00
Vincent Yang fc379e3ecd updated description for wuzz 2017-03-07 23:48:28 -08:00
Agniva De Sarker c0ba2afc2b zip.md: wrap compression level in tokens 2017-03-07 23:59:12 +05:30
Jaehoon Choi eee1e72ba2 `zip`: explain how to specify the compression level 2017-03-07 23:59:12 +05:30
Risen-phoenix 24b014d3e9 Update hangups.md 2017-03-07 12:01:53 -05:00
Risen-phoenix f253004776 hangups: add page 2017-03-07 11:59:27 -05:00
Vincent Yang aff5bbe9ef fix formating to please unit tests 2017-03-01 17:30:30 -08:00
Vincent Yang 77faf2a0f1 added wuzz 2017-03-01 16:33:18 -08:00
Agniva De Sarker 8c89cf4613 update qlimage.md 
Wrapped some values in tokens.
 2017-03-01 22:26:43 +05:30
Jeef 9cbf518ad3 Update qlmanage.md 2017-03-01 22:26:43 +05:30
Agniva De Sarker 5426316b23 Adding clarity on how to enter the password 2017-03-01 22:01:50 +05:30
Josa Gesell 50d33b2cab msmtp: add page 2017-03-01 22:01:50 +05:30
Jakub Kubryński b937aa13a8 Add description how to use lsof by PID 2017-03-01 21:13:17 +05:30
Jeef c10d09d0bd carthage.md: add page (#1278) 2017-03-01 10:24:20 +05:30
lukasschlueter a0f37ef1ef consul: add page (#1277) 2017-02-28 16:01:38 +05:30
kalebo 262561ca78 Changing wording in scale example 
* 'decimal places' used instead of 'precision'  
* Implicit example of using scale
 2017-02-26 10:26:11 +05:30
kalebo e3f1d3377f simplification 
* merged lines about interactive mode and mathlib
 2017-02-26 10:26:11 +05:30
kalebo 1b5152e58f Added a line about interactive usage with mathlib 
Usually `bc` isn't very useful if it doesn't return have floating point number where appropriate. e.g., 3/4 returns 0 when started with `-i` but for most users they would expect 0.75 to be returned so the argument `-l`does what the user would generally want.
 2017-02-26 10:26:11 +05:30
Agniva De Sarker abd52f0ce8 ssh-copy-id: Remove default key example 2017-02-25 17:49:50 +05:30