net-ssh 1.0.0 → 1.0.1

data/doc/manual-html/stylesheets/manual.css

@@ -0,0 +1,270 @@
+body {
+  background: #FFF;
+  font-family: sans-serif;
+  color: #000;
+  margin: 0px;
+}
+
+a {
+  color: #00F;
+  text-decoration: none;
+}
+
+a:hover {
+  text-decoration: underline;
+}
+
+.product-manual {
+  text-align: center;
+  font-size: x-large;
+  font-variant: small-caps;
+  font-weight: bold;
+  color: #005;
+}
+
+.copyright {
+  text-align: center;
+  font-size: small;
+  font-style: italic;
+  color: #005;
+  margin-top: 1in;
+}
+
+#banner {
+  background: #005;
+  color: #FFF;
+  border-bottom: 1px solid #000;
+  padding-top: 0.5em;
+  padding-bottom: 0.5em;
+  padding-left: 1em;
+  margin-bottom: 1em;
+}
+
+#banner .title {
+  font-size: x-large;
+}
+
+#banner .title:first-letter {
+  font-size: 250%;
+  font-weight: normal;
+  float: left;
+  margin-top: -7px;
+  margin-bottom: -7px;
+}
+
+#banner .product {
+  font-weight: bold;
+  color: #FF7;
+  letter-spacing: 0.5em;
+}
+
+#banner .tagline {
+  font-style: italic;
+  font-size: large;
+  letter-spacing: 0.1em;
+  color: #FFF;
+}
+
+#banner .info {
+  color: white;
+  font-size: small;
+  padding-right: 1em;
+}
+
+#content {
+  margin-left: 0cm;
+  margin-right: 1cm;
+}
+
+#navigation {
+  font-size: x-small;
+  border-right: 2px groove black;
+  border-top: 2px groove black;
+  margin-right: 1em;
+  width: 200px;
+  height: 100%;
+  background: #FFD;
+}
+
+#navigation ul, #navigation ol {
+  margin-left: 1.2em;
+  padding-left: 1.2em;
+}
+
+#navigation .license {
+  font-size: x-small;
+  text-align: center;
+  border-top: 1px dashed #005;
+  margin-top: 2em;
+  padding: 1em;
+}
+
+.section {
+  margin-bottom: 1em;
+}
+
+.section p {
+  text-align: justify;
+}
+
+#content h1 {
+  background: #005;
+  color: #FFF;
+  font-size: x-large;
+  font-weight: bold;
+  font-variant: small-caps;
+  padding: 0.5em;
+  border: 1px solid #000;
+  margin-top: 0px;
+  margin-bottom: 1em;
+}
+
+#content h2 {
+  background: #005;
+  color: #FFF;
+  font-size: large;
+  font-weight: bold;
+  font-variant: small-caps;
+  padding: 0.25em;
+  padding-left: 0.5em;
+  border: 1px solid #000;
+  margin-bottom: 1em;
+}
+
+#content h3 {
+  background: #FFD;
+  color: #000;
+  font-size: normal;
+  font-weight: bold;
+  font-variant: small-caps;
+  padding: 0.25em;
+  padding-left: 0.5em;
+  border: 1px dotted #000;
+  margin-bottom: 1em;
+}
+
+#content h4 {
+  background: #FFE;
+  color: #000;
+  font-size: normal;
+  font-weight: bold;
+  font-variant: small-caps;
+  padding: 0.25em;
+  padding-left: 0.5em;
+  border: 1px dotted #777;
+  margin-bottom: 1em;
+}
+
+#navigation h1 {
+  margin: 0px;
+  padding: 1em;
+  color: #005;
+  background: transparent;
+  font-weight: bold;
+  font-size: 150%;
+  font-variant: small-caps;
+  text-align: center;
+}
+
+#navigation h2 {
+  margin: 0px;
+  margin-bottom: 1em;
+  padding: 0.5em;
+  border-top: 1px dashed #005;
+  border-bottom: 1px dashed #005;
+  color: #005;
+  background: transparent;
+  font-weight: bold;
+  font-size: 125%;
+  font-variant: small-caps;
+  text-align: center;
+}
+
+table.list {
+  margin: 2em;
+  border: 1px solid black;
+  background: #FFD;
+  padding: 0px;
+  border-spacing: 0px;
+}
+
+table.list th {
+  border-bottom: 1px solid #005;
+  padding-bottom: 5px;
+  background: #008;
+  color: white;
+  padding: 0.5em;
+  text-align: left;
+}
+
+table.list td {
+  padding: 0.2em;
+  text-align: left;
+  vertical-align: top;
+  border-bottom: 1px solid;
+}
+
+.prevnext {
+  padding: 0.5em 1em 0.5em 1em;
+  background: #557;
+  color: #FFF;
+  font-size: small;
+  font-weight: bold;
+  border: 1px solid #000;
+}
+
+.prevnext a {
+  color: #FF0;
+}
+
+.top .prevnext {
+  margin: 0 0 1em 0;
+  text-align: left;
+}
+
+.bottom .prevnext {
+  margin: 1em 0 0 0;
+  text-align: right;
+}
+
+.figure {
+  border: 1px solid black;
+  line-height: normal;
+  background: #FFD;
+  margin: 2em;
+}
+
+.figure .caption {
+  background: #008;
+  color: white;
+  font-weight: bold;
+  font-size: small;
+  padding: 4px 24px 4px 8px;
+  margin-left: -4px;
+  border: 1px dotted #77F;
+}
+
+.figure table {
+  padding-top: 0.8em;
+  padding-bottom: 0.5em;
+}
+
+.figure .body {
+  padding-left: 1em;
+}
+
+.figure pre {
+  padding: 0px;
+  background: transparent;
+  border: none;
+  font-size: small;
+  font-family: monospace;
+}
+
+.figure .lineno {
+  text-align: right;
+  color: #B00;
+  font-family: monospace;
+  font-size: small;
+  padding-right: 1em;
+}

data/doc/manual-html/stylesheets/ruby.css

@@ -0,0 +1,17 @@
+.ruby .normal {}
+.ruby .comment { color: #005; font-style: italic; }
+.ruby .keyword { color: #A00; font-weight: bold; }
+.ruby .method { color: #077; }
+.ruby .class { color: #074; }
+.ruby .module { color: #050; }
+.ruby .punct { color: #447; font-weight: bold; }
+.ruby .symbol { color: #099; }
+.ruby .string { color: #944; }
+.ruby .char { color: #F07; }
+.ruby .ident { color: #004; }
+.ruby .constant { color: #07F; }
+.ruby .regex { color: #B66; }
+.ruby .number { color: #D55; }
+.ruby .attribute { color: #377; }
+.ruby .global { color: #3B7; }
+.ruby .expr { color: #227; }

data/doc/manual/manual.rb

@@ -125,7 +125,7 @@ module Net ; module SSH
 
         def extract_figures
           @figures = []
-          @content.gsub!( /^\[!figure( .*?)?\n(.*?)\n!\]$/m ) do
+          @content.gsub!( /^\{\{\{(.*?)?\n(.*?)\n\}\}\}$/m ) do
             body = $2.strip
             opts = Hash[*$1.strip.split(/,/).map{|p| p.split(/=/)}.flatten]
             @figures << Figure.new( opts, body )
@@ -234,7 +234,7 @@ module Net ; module SSH
     end
 
   end
-end
+end; end
 
 if __FILE__ == $0
 

data/doc/manual/manual.yml

@@ -8,7 +8,7 @@
 meta: !^meta
   copyright: 2004,2005
   author: Jamis Buck
-  email: jgb3@email.byu.edu
+  email: jamis@jamisbuck.org
 
 product: !^product
   name: Net::SSH
@@ -23,55 +23,52 @@ product: !^product
     - Net::SSH Wiki: http://net-ssh.rubyforge.org/wiki/wiki.pl
 
 recent_updates:
-  - "Next/Previous links on each chapter for easier navigation"
-  - "Shell service"
-  - "Enhancements to the channel and connection interfaces"
-  - "Keyboard-interactive authentication method"
+  - "Updated from the (now-defunct) Hieraki version of the documentation"
 
 chapters:
 
-- Introduction:
-  - "What is Net::SSH?": !!file parts/intro_what_is.txt
-  - "What isn't Net::SSH?": !!file parts/intro_what_is_not.txt
-  - "Getting Net::SSH": !!file parts/intro_getting.txt
-  - License Information: !!file parts/intro_license.txt
-  - Support: !!file parts/intro_support.txt
-  - About the Author: !!file parts/intro_author.txt
+- "Introduction":
+  - "What is Net::SSH?": !!file parts/0000.txt
+  - "What isn't Net::SSH?": !!file parts/0001.txt
+  - "Getting Net::SSH": !!file parts/0002.txt
+  - "License Information": !!file parts/0003.txt
+  - "Support": !!file parts/0004.txt
+  - "About the Author": !!file parts/0005.txt
 
-- Starting a Session:
-  - "Using Net::SSH.start": !!file parts/session_start.txt
-  - Using a Public/Private Key: !!file parts/session_key.txt
-  - Options: !!file parts/session_options.txt
-  - "Using Net::SSH::Session": !!file parts/session_session.txt
+- "Starting a Session":
+  - "Using Net::SSH.start": !!file parts/0006.txt
+  - "Using a Public/Private Key": !!file parts/0007.txt
+  - "Options": !!file parts/0008.txt
+  - "Using Net::SSH::Session": !!file parts/0009.txt
 
-- Channels:
-  - What are Channels?: !!file parts/channels_what_are.txt
-  - Session.loop: !!file parts/channels_loop.txt
-  - Channel Types: !!file parts/channels_types.txt
-  - Opening a Channel: !!file parts/channels_open.txt
-  - Callbacks: !!file parts/channels_callbacks.txt
-  - Channel Operations: !!file parts/channels_operations.txt
+- "Channels":
+  - "What are Channels?": !!file parts/0010.txt
+  - "Session.loop": !!file parts/0011.txt
+  - "Channel Types": !!file parts/0012.txt
+  - "Opening a Channel": !!file parts/0013.txt
+  - "Callbacks": !!file parts/0014.txt
+  - "Channel Operations": !!file parts/0015.txt
 
-- Executing Commands:
-  - Using Channels: !!file parts/exec_channels.txt
-  - "Using #process.open": !!file parts/exec_open.txt
-  - "Using #process.popen3": !!file parts/exec_popen3.txt
+- "Executing Commands":
+  - "Using Channels": !!file parts/0016.txt
+  - "Using #process.open": !!file parts/0017.txt
+  - "Using #process.popen3": !!file parts/0018.txt
 
-- User Shells:
-  - Introduction: !!file parts/shells_intro.txt
-  - Using Channels: !!file parts/shells_channels.txt
-  - Shell Service: !!file parts/shells_shell.txt
-  - SyncShell Service: !!file parts/shells_sync.txt
-  - Terminal Clients: !!file parts/shells_clients.txt
+- "User Shells":
+  - "Introduction": !!file parts/0019.txt
+  - "Using Channels": !!file parts/0020.txt
+  - "Shell Service": !!file parts/0021.txt
+  - "SyncShell Service": !!file parts/0022.txt
+  - "Terminal Clients": !!file parts/0023.txt
 
-- Port Forwarding:
-  - Introduction: !!file parts/forward_intro.txt
-  - Local-to-Remote: !!file parts/forward_local.txt
-  - Remote-to-Local: !!file parts/forward_remote.txt
-  - Direct Channels: !!file parts/forward_direct.txt
-  - Remote-to-Local Handlers: !!file parts/forward_handlers.txt
+- "Port Forwarding":
+  - "Introduction": !!file parts/0024.txt
+  - "Local-to-Remote": !!file parts/0025.txt
+  - "Remote-to-Local": !!file parts/0026.txt
+  - "Direct Channels": !!file parts/0027.txt
+  - "Remote-to-Local Handlers": !!file parts/0028.txt
 
-- Using Proxies:
-  - Introduction: !!file parts/proxy_intro.txt
-  - HTTP: !!file parts/proxy_http.txt
-  - SOCKS: !!file parts/proxy_socks.txt
+- "Using Proxies":
+  - "Introduction": !!file parts/0029.txt
+  - "HTTP": !!file parts/0030.txt
+  - "SOCKS": !!file parts/0031.txt

data/doc/manual/parts/{intro_getting.txt → 0002.txt}

@@ -10,9 +10,9 @@ h3. Using "RubyGems":http://rubygems.rubyforge.org
 
 If you have "RubyGems":http://rubygems.rubyforge.org installed, installing Net::SSH is simple:
 
-[!figure lang=shell,caption=Using Rubygems to install Net::SSH
+{{{lang=shell,caption=Using Rubygems to install Net::SSH
 gem install net-ssh
-!]
+}}}
 
 You still need to make sure you have a working version of Ruby's OpenSSL module, but other than that, you should be good to go!
 
@@ -20,9 +20,9 @@ h3. Using "rpa-base":http://rpa-base.rubyforge.org
 
 If you have "rpa-base":http://rpa-base.rubyforge.org installed:
 
-[!figure lang=shell,caption=Using RPA to install Net::SSH
+{{{lang=shell,caption=Using RPA to install Net::SSH
 rpa install net-ssh
-!]
+}}}
 
 As with the gem install, you still need to make sure you have a working version of Ruby's OpenSSL module, but other than that, you should be good to go!
 
@@ -32,8 +32,9 @@ If you don't have "RubyGems":http://rubygems.rubyforge.org or "rpa-base":http://
 
 Then, unpack the archive and run the @setup.rb@ script:
 
-[!figure lang=shell,caption=Using setup.rb to install Net::SSH
+{{{lang=shell,caption=Using setup.rb to install Net::SSH
 ruby setup.rb config
 ruby setup.rb setup
 ruby setup.rb install
-!]
+}}}
+