[DRE-commits] [ruby-httpclient] 17/18: Add manpage for jsonclient

[Hleb Valoshka]

This is an automated email from the git hooks/post-receive script.

tsfgnu-guest pushed a commit to branch master
in repository ruby-httpclient.

commit aa4c5eddc8aa0069cf3bcce8946a6360fd823548
Author: Hleb Valoshka <375gnu at gmail.com>
Date:   Mon Aug 17 16:36:53 2015 +0300

    Add manpage for jsonclient
---
 debian/copyright                |  5 ++++
 debian/jsonclient.1             | 52 +++++++++++++++++++++++++++++++++++++++++
 debian/ruby-httpclient.manpages |  1 +
 3 files changed, 58 insertions(+)

diff --git a/debian/copyright b/debian/copyright
index 01da372..3b23d66 100644
--- a/debian/copyright
+++ b/debian/copyright
@@ -18,6 +18,11 @@ Files: debian/httpclient.1
 Copyright: © 2013 Gunnar Wolf <gwolf at debian.org>
 License: GPL-2+
 
+Files: debian/jsonclient.1
+Copyright: © 2013 Gunnar Wolf <gwolf at debian.org>
+           © 2015 Hleb Valoshka <375gnu at gmail.com>
+License: GPL-2+
+
 License: Ruby
  This program is copyrighted free software by NAKAMURA, Hiroshi.  You can
  redistribute it and/or modify it under the same terms of Ruby's license;
diff --git a/debian/jsonclient.1 b/debian/jsonclient.1
new file mode 100644
index 0000000..3e0fb17
--- /dev/null
+++ b/debian/jsonclient.1
@@ -0,0 +1,52 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.TH jsonclient 1 "2015-08-17"
+.SH NAME
+jsonclient \- Shell command for performing HTTP/JSON requests using Ruby jsonclient
+.SH SYNOPSIS
+.TP
+jsonclient <method> <uri> [params]
+.TP
+jsonclient
+.SH DESCRIPTION
+This program is an example/companion to the Ruby jsonclient module,
+but can be used as a complete standalone HTTP/JSON client.
+.PP
+If invoked with a method and an URI, the specified URI will be
+requested via the method given from its server. The allowed methods
+are \fBhead\fP, \fBget\fP, \fBpost\fP, \fBput\fP, \fBdelete\fP,
+\fBoptions\fP, \fBpropfind\fP, \fBproppatch\fP and
+\fBtrace\fP.
+.PP
+Parameters can be specified as a third parameter and will be delivered
+accordingly (i.e. appended to the URI after a \fB?\fP sign if the
+method is \fBget\fP, but as the posted body if the method is
+\fBpost\fP)
+.PP
+Please note that no checks are done as to whether the requested
+parameters make sense in the context they are specified, they are just
+sent as-is.
+.TP
+$ jsonclient get https://www.google.co.jp/ q=ruby
+.PP
+If no parameters are specified, an interactive Ruby (\fBirb\fP)
+session will be opened, binding an JSONClient object as 'self'. You
+can then call JSONClient instance methods like:
+.TP
+$ jsonclient
+>> get "https://www.google.co.jp/", :q => :ruby
+.PP
+JSONclient will print the `wiredump' of your request (that is, the
+commands sent to the server via HTTP), then the request's headers, and
+finally the result.
+.SH OPTIONS
+.SH AUTHORS
+Gunnar Wolf <gwolf at debian.org>, Hleb Valoshka <375gnu at gmail.com>
+.SH NOTES
+This manual page was written by Gunnar Wolf <gwolf at debian.org> and
+Hleb Valoshka <375gnu at gmail.com> for the Debian project, but can be freely used
+by others.
+
+This is free documentation; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation; either version 2 of the License, or (at your
+option) any later version.
diff --git a/debian/ruby-httpclient.manpages b/debian/ruby-httpclient.manpages
index cba67b0..843c10b 100644
--- a/debian/ruby-httpclient.manpages
+++ b/debian/ruby-httpclient.manpages
@@ -1 +1,2 @@
 debian/httpclient.1
+debian/jsonclient.1

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ruby-extras/ruby-httpclient.git