gist 3.1.1 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,117 +0,0 @@
1
- gist(1) -- gist on the command line
2
- ===================================
3
-
4
- ## SYNOPSIS
5
-
6
- `gist` [`-p`] [`-t extension`] <FILE|->
7
-
8
- ## DESCRIPTION
9
-
10
- `gist` can be used to create gists on gist.github.com from the command
11
- line. There are two primary methods of creating gists.
12
-
13
- If standard input is supplied, it will be used as the content of the
14
- new gist. If <FILE> is provided, the content of that file will be used
15
- to create the gist. If <FILE> is '-' then gist will wait for content
16
- from standard input.
17
-
18
- Once your gist is successfully created, the URL will be copied to your
19
- clipboard. If you are on OS X, `gist` will open the gist in your
20
- browser, too.
21
-
22
- ## OPTIONS
23
-
24
- `gist`'s default mode of operation is to read content from standard
25
- input and create a public, text gist without description from it, tied
26
- to your GitHub account if you user and passwordare provided (see
27
- `CONFIGURATION`).
28
-
29
- These options can be used to change this behavior:
30
-
31
- * `-p`, `--private`:
32
- Create a private gist instead of a public gist.
33
-
34
- * `-t`, `--type`:
35
- Set the file extension explicitly. Passing a type of `rb` ensures
36
- the gist is created as a Ruby file.
37
-
38
- * `-d`, `--description`:
39
- Set a description.
40
-
41
- * `-o`, `--[no-]open`:
42
- Open the gist in your browser after creation. Or don't. Defaults
43
- to --open
44
-
45
- You may additionally ask for help:
46
-
47
- * `-h`, `--help`:
48
- Print help.
49
-
50
- * `-m`, `--man`:
51
- Display this man page.
52
-
53
- ## AUTHENTICATION
54
-
55
- There are two ways to set GitHub user and password info:
56
-
57
- * Using environment vars GITHUB_USER and GITHUB_PASSWORD
58
-
59
- $ export GITHUB_USER=johndoe
60
- $ export GITHUB_PASSWORD=mysecretgithubpassword
61
- $ gist ~/example
62
-
63
- * Using git-config(1)
64
-
65
- Use git-config(1) to display the currently configured GitHub username:
66
-
67
- $ git config --global github.user
68
-
69
- Or, set the GitHub username with:
70
-
71
- $ git config --global github.user <username>
72
-
73
- See <http://github.com/guides/local-github-config> for more
74
- information.
75
-
76
- ## CONFIGURATION
77
-
78
- You can set a few options in your git config (using git-config(1)) to
79
- control the default behavior of gist(1).
80
-
81
- * gist.private - boolean (yes or no) - Determines whether to make a gist
82
- private by default
83
-
84
- * gist.extension - string - Default extension for gists you create.
85
-
86
- * gist.browse - boolean (yes or no) - Whether to open the gist in your
87
- browser after creation. Default: yes
88
-
89
- ## ENVIRONMENT
90
-
91
- The following environment variables affect the execution of `gist`:
92
-
93
- * HTTP_PROXY - Proxy to use when Gisting. Should be "http://host:port/"
94
-
95
- ## EXAMPLES
96
-
97
- $ gist < file.txt
98
- $ echo secret | gist --private
99
- $ echo "puts :hi" | gist -t rb
100
- $ gist script.py
101
- $ gist -
102
- the quick brown fox jumps over the lazy dog
103
- ^D
104
-
105
- ## BUGS
106
-
107
- <http://github.com/defunkt/gist/issues>
108
-
109
- ## AUTHOR
110
-
111
- Chris Wanstrath :: chris@ozmm.org
112
-
113
- ## SEE ALSO
114
-
115
- hub(1), git(1), git-clone(1),
116
- <http://github.com>,
117
- <http://github.com/defunkt/gist>