rclone/vendor/github.com/pkg/sftp/README.md

49 lines
1.7 KiB
Markdown
Raw Normal View History

2016-11-13 08:04:55 +08:00
sftp
----
The `sftp` package provides support for file system operations on remote ssh
servers using the SFTP subsystem. It also implements an SFTP server for serving
files from the filesystem.
[![UNIX Build Status](https://travis-ci.org/pkg/sftp.svg?branch=master)](https://travis-ci.org/pkg/sftp) [![GoDoc](http://godoc.org/github.com/pkg/sftp?status.svg)](http://godoc.org/github.com/pkg/sftp)
usage and examples
------------------
See [godoc.org/github.com/pkg/sftp](http://godoc.org/github.com/pkg/sftp) for
examples and usage.
The basic operation of the package mirrors the facilities of the
[os](http://golang.org/pkg/os) package.
The Walker interface for directory traversal is heavily inspired by Keith
Rarick's [fs](http://godoc.org/github.com/kr/fs) package.
roadmap
-------
* There is way too much duplication in the Client methods. If there was an
unmarshal(interface{}) method this would reduce a heap of the duplication.
contributing
------------
We welcome pull requests, bug fixes and issue reports.
Before proposing a large change, first please discuss your change by raising an
issue.
For API/code bugs, please include a small, self contained code example to
reproduce the issue. For pull requests, remember test coverage.
We handle issues and pull requests with a 0 open philosophy. That means we will
try to address the submission as soon as possible and will work toward a
resolution. If progress can no longer be made (eg. unreproducible bug) or stops
(eg. unresponsive submitter), we will close the bug.
Please remember that we don't have infinite time and so it is a good guideline
that the less time it takes us to work with you on your idea/issue the greater
the chance we will have the time to do it.
Thanks.