Net::SSH Manual

Chapters

1. Introduction
   1. What is Net::SSH?
   2. What isn’t Net::SSH?
   3. Getting Net::SSH
   4. License Information
   5. Support
   6. About the Author
2. Starting a Session
   1. Using Net::SSH.start
   2. Using a Public/Private Key
   3. Options
   4. Using Net::SSH::Session
3. Channels
   1. What are Channels?
   2. Session.loop
   3. Channel Types
   4. Opening a Channel
   5. Callbacks
   6. Channel Operations
4. Executing Commands
   1. Using Channels
   2. Using #process.open
   3. Using #process.popen3
5. User Shells
   1. Introduction
   2. Using Channels
   3. Shell Service
   4. SyncShell Service
   5. Terminal Clients
6. Port Forwarding
   1. Introduction
   2. Local-to-Remote
   3. Remote-to-Local
   4. Direct Channels
   5. Remote-to-Local Handlers
7. Using Proxies
   1. Introduction
   2. HTTP
   3. SOCKS

Other Documentation

• Net::SSH API
• Net::SSH FAQ (OUTDATED)

Tutorials

More To Come...

Product Manual

Project Page: https://github.com/net-ssh/
User Manual: http://net-ssh.github.com
API Documentation: http://net-ssh.github.com/api

Recent Updates to This Manual

Added information on ssh-agent forwarding. Added information about the :paranoid setting.

Copyright © 2004-2007 Jamis Buck (jamis@jamisbuck.org)