/
index.html
executable file
·120 lines (103 loc) · 5.97 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>tldr pages</title>
<meta name="author" content="tldr pages team">
<meta name="description" content="Simplified and community-driven man pages">
<meta name="keywords" content="man, unix, linux, mac, osx, macos, commands, command-line, shell, bash, zsh">
<meta name="robots" content="noodp,noydir">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/normalize/5.0.0/normalize.min.css">
<link rel="stylesheet" href="assets/css/index.css">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Montserrat|Inconsolata:400,700|Source+Code+Pro">
<link rel="icon" type="image/png" href="assets/img/icon.png" />
<link href="https://fosstodon.org/@tldr_pages" rel="me" />
</head>
<body>
<div class="container">
<h1>tldr pages</h1>
<blockquote>Simplified and community-driven man pages</blockquote>
<p class="widgets">
<a href="https://github.com/tldr-pages/tldr" target="_blank"><img alt="GitHub stars" src="https://img.shields.io/github/stars/tldr-pages/tldr.svg?logo=github"></a>
<a href="https://twitter.com/tldr_pages" target="_blank"><img alt="Twitter" src="https://img.shields.io/badge/twitter-tldr__pages-%231DA1F2.svg"></a>
<a href="https://fosstodon.org/@tldr_pages" target="_blank"><img alt="Fosstodon" src="https://img.shields.io/badge/fosstodon-tldr__pages-blue"></a>
<a href="https://matrix.to/#/#tldr-pages:matrix.org" target="_blank"><img alt="Matrix" src="https://img.shields.io/matrix/tldr-pages:matrix.org?label=chat+on+Matrix"></a>
</p>
<p>
The tldr pages are a community effort
to simplify the beloved <a href="https://en.wikipedia.org/wiki/Man_page">man pages</a>
with practical examples.
</p>
<p><img src="assets/img/screenshot.png" alt="tldr screenshot"></p>
<p>
Try the <a href="https://tldr.inbrowser.app" target="blank">live demo</a> below,
have a look at the <a href="/assets/tldr-book.pdf">PDF version</a>,
or follow the <a href="#installation">installation instructions</a>.
</p>
<noscript>
<div id="enable_js">
<p>The live demo requires JavaScript to function. To access the content, please enable JavaScript in your browser settings.</p>
</div>
</noscript>
<iframe id="iframe-content" src="https://tldr.inbrowser.app/pages/common/tar" width="100%" height="500px" style="border: 1px solid"></iframe>
<h2 id="installation">
<a href="#installation">§</a>
Installation
</h2>
<p>As of now, our most mature client is the Node.js one, which you can easily install from npm:</p>
<pre>npm install -g tldr</pre>
<p>
There are many more clients that have sprouted from the community, including:
<ul>
<li>command-line clients</li>
<li>GUI clients for desktop and mobile</li>
<li>web-based clients</li>
<li>clients which integrate with other applications</li>
</ul>
They can be found <a href="https://github.com/tldr-pages/tldr/wiki/tldr-pages-clients">in the wiki.</a>
</p>
<h2 id="contributing">
<a href="#contributing">§</a>
Contributing
</h2>
<p>
This repository is an ever-growing collection of examples
for the most common UNIX, Linux, macOS, SunOS, Android and Windows commands.
</p>
<p>
You're encouraged to create or edit pages
in the <code>pages/</code> folder
at the <a href="https://github.com/tldr-pages/tldr">project's repository</a>
and submit a pull request.
</p>
<p>
Just keep in mind the
<a href="https://github.com/tldr-pages/tldr/blob/main/CONTRIBUTING.md">Contributing guidelines</a>.
</p>
<h2 id="license">
<a href="#license">§</a>
License
</h2>
<p><a href="https://github.com/tldr-pages/tldr/blob/main/LICENSE.md">MIT License</a></p>
</div>
<a href="https://github.com/tldr-pages/tldr" class="github-corner" aria-label="View source on GitHub"><svg width="80" height="80" viewBox="0 0 250 250" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a>
<script>
document.addEventListener('DOMContentLoaded', function() {
let iframe = document.getElementById('iframe-content');
let noscript = document.querySelector('noscript');
iframe.style.display = 'block';
noscript.style.display = 'none';
});
</script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-71864986-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>