File: tldr-py.1

package info (click to toggle)
tldr-py 0.7.0-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster
  • size: 212 kB
  • sloc: python: 503; makefile: 14; sh: 13
file content (53 lines) | stat: -rw-r--r-- 922 bytes parent folder | download | duplicates (3)
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
.TH TLDR "1" "November 2017" "Python client for tldr"

.SH NAME
tldr \- Python client for tldr

.SH SYNOPSIS
.B tldr
\fR[\fIOPTIONS\fR] \fICOMMAND\fR \fR[\fIARGS\fR]...

.SH DESCRIPTION
.PP
Yet another Python client for tldr. tldr is a collection of simplified and
community-driven man pages.

.SH OPTIONS
.TP
\fB\-V\fR, \fB\-\-version\fR
Show the version and exit.
.TP
\fB\-h\fR, \fB\-\-help\fR
Show the help and exit.

.SH COMMANDS
.TP
\fBfind\fR
Find the command usage.
.TP
\fBinit\fR
Init config file.
.TP
\fBreindex\fR
Rebuild the index.
.TP
\fBupdate\fR
Update to the latest pages.

.SH EXAMPLES
.nf
.PP
.B Download tldr pages and init config
$ git clone git@github.com:tldr-pages/tldr.git ~/.tldr
$ tldr init
Input the tldr repo path(absolute path): /home/<user>/.tldr
Input your platform(linux, osx or sunos): linux
$ tldr reindex

.PP
.B Update tldr pages
$ tldr update

.PP
.B Show tar tldr page
$ tldr find tar