commit 96b4d1f5d793d488068ec7de58d0bb22fc4bcc8e
parent 33680e7ebf283de6f2013e62a384144cbe75a763
Author: Ed van Bruggen <edvb54@gmail.com>
Date: Sat, 29 Jul 2017 22:49:27 -0700
proj: update gs page
Diffstat:
| projects/gs.md | | | 114 | ++++++++++++++++++++++++++++++++++++++++++++++++------------------------------- |
1 file changed, 69 insertions(+), 45 deletions(-)
diff --git a/projects/gs.md b/projects/gs.md
@@ -1,83 +1,107 @@
---
title: gs
-description: 'gist creator'
-tags: c linux cli github gist curl json api
+description: 'painless gist creator'
+tags: c linux cli github gist curl json api suckless simple
---
-Easy way to create Github gists with the command line.
+Easy way to create GitHub Gists through the command line.
## OPTIONS
-**-d** *DESCRIPTION*
- Set gist description
+#### -d DESCRIPTION
-**-f** *FILENAME*
- Set file name when reading from `stdin`
+Set Gist description
-**-p**
- Make gist private
+#### -f FILENAME
-**-P**
- Make gist public (default)
+Set file name when reading from `stdin`
-**-u** *USER*[:*PASSWORD*]
- Change the Github account the gist will be posted under. A password can
- given as well with a separating colon, a prompt is provided if not.
+#### -p
-**-U**
- Post gist anonymously (default)
+Make Gist private
-**-h**
- Print help and exit
+#### -P
-**-v**
- Print version info and exit
+Make Gist public (default)
+
+#### -u USER[:PASSWORD]
+
+Change the GitHub account the Gist will be posted under. A password can
+given as well with a separating colon, a prompt is provided if not.
+
+#### -U
+
+Post Gist anonymously (default)
+
+#### -h
+
+Print help and exit
+
+#### -v
+
+Print version info and exit
## USAGE
-Create a new gist of file `file.txt`:
+Create a new Gist of file `file.txt`:
- $ gs file.txt
- https://gist.github.com/<new-id>
+```
+$ gs file.txt
+https://gist.github.com/<new-id>
+```
-There is also support for multiple files in a single gist:
+There is also support for multiple files in a single Gist:
- $ gs README.md Makefile prog.c
- https://gist.github.com/<new-id>
+```
+$ gs README.md Makefile prog.c
+https://gist.github.com/<new-id>
+```
-Specify the gist's description:
+Specify the Gist's description:
- $ gs -d 'a cool shell script' script.sh
- https://gist.github.com/<new-id>
+```
+$ gs -d 'a cool shell script' script.sh
+https://gist.github.com/<new-id>
+```
-The gist's URL can be piped to other programs, for example to your clipboard to
+The Gist's URL can be piped to other programs, for example to your clipboard to
be pasted else where:
- $ gs file.txt | xsel -bi
+```
+$ gs file.txt | xsel -bi
+```
-You can also create a new gist from `stdin`. The file name needs to be supplied
+You can also create a new Gist from `stdin`. The file name needs to be supplied
however:
- $ cmd-which-errors | gs -f log.txt
- https://gist.github.com/<new-id>
+```
+$ cmd-which-errors | gs -f log.txt
+https://gist.github.com/<new-id>
+```
-New gists can be private as well:
+New Gists can be private as well:
- $ gs -p personal.info
- https://gist.github.com/<new-id>
+```
+$ gs -p personal.info
+https://gist.github.com/<new-id>
+```
-The new gist can be posted under a Github user, a prompt will ask for your
+The new Gist can be posted under a GitHub user, a prompt will ask for your
password:
- $ gs -u your-name good-proj.rs
- Github password:
- https://gist.github.com/<new-id>
+```
+$ gs -u your-name good-proj.rs
+GitHub password:
+https://gist.github.com/<new-id>
+```
To skip the prompt your password can be supplied after a colon with the
username:
- $ gs -u your-name:password plugin/func.vim doc/func.txt
- https://gist.github.com/<new-id>
+```
+$ gs -u your-name:password plugin/func.vim doc/func.txt
+https://gist.github.com/<new-id>
+```
## AUTHOR
@@ -85,9 +109,9 @@ Ed van Bruggen <edvb54@gmail.com>
## SEE ALSO
-See project page at: <http://edryd.org/projects/gs.html>
+See project page at <http://edryd.org/projects/gs.html>
-View source code at: <https://github.com/edvb/gs>
+View source code at <https://github.com/edvb/gs>
## LICENSE
