This is the lftp-wrapper Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jul 13 20:48:47 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
lftp-wrapperWrapper around the lftp program, used for a SFTP client.
vindarel
(GIT https://github.com/vindarel/lftp-wrapper/)
WTFPL
0.1
secret-values (system).
str (system).
termp (system).
trivial-types (system).
log4cl (system).
src (module).
Modules are listed depth-first from the system components tree.
lftp-wrapper/srclftp-wrapper (system).
lftp.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
lftp-wrapper/src/lftp.lispsrc (module).
*devel* (special variable).
*dry-run* (special variable).
*ftp-hostname* (special variable).
*ftp-login* (special variable).
*show-passwords* (special variable).
*version* (special variable).
build-command (generic function).
command (class).
hostname (reader method).
(setf hostname) (writer method).
login (reader method).
(setf login) (writer method).
make-profile (function).
make-profile-from-plist (generic function).
password (reader method).
(setf password) (writer method).
port (reader method).
(setf port) (writer method).
print-object (method).
print-object (method).
print-object (method).
print-password (method).
profile (class).
put (class).
run (generic function).
server (reader method).
(setf server) (writer method).
sftp-profile (class).
cd (reader method).
(setf cd) (writer method).
error-or-quit (function).
find-ftp-login (function).
find-ftp-password (function).
find-ftp-port (function).
find-ftp-server (function).
local-filename (generic function).
(setf local-filename) (writer method).
protocol (reader method).
(setf protocol) (writer method).
Packages are listed by definition order.
lftp-wrappercommon-lisp.
*devel* (special variable).
*dry-run* (special variable).
*ftp-hostname* (special variable).
*ftp-login* (special variable).
*show-passwords* (special variable).
*version* (special variable).
build-command (generic function).
command (class).
hostname (generic reader).
(setf hostname) (generic writer).
login (generic reader).
(setf login) (generic writer).
make-profile (function).
make-profile-from-plist (generic function).
password (generic reader).
(setf password) (generic writer).
port (generic reader).
(setf port) (generic writer).
print-password (generic function).
profile (class).
put (class).
run (generic function).
server (generic reader).
(setf server) (generic writer).
sftp-profile (class).
cd (generic reader).
(setf cd) (generic writer).
error-or-quit (function).
find-ftp-login (function).
find-ftp-password (function).
find-ftp-port (function).
find-ftp-server (function).
local-filename (generic function).
(setf local-filename) (generic writer).
protocol (generic reader).
(setf protocol) (generic writer).
Definitions are sorted by export status, category, package, and then by lexicographic order.
If t, get FTP interactive errors
If T, don’t send the SFTP command.
(s)FTP hostname to connect to (string).
(s)FTP login (string).
If non nil, print passwords in clear text on stdout when debugging commands.
Create a PROFILE instance by searching for credentials in environment variables or files.
The password is also read, but concealed.
run lftp for the sftp protocol.
If DRY-RUN is non nil, include the password in clear text and really run the command.
Currently done for PUT commands.
Create a PROFILE instance with slots taken from PLIST. PLIST has the keys :server, :port, :login, :password etc.
Run COMMAND, using the login credentials in PROFILE.
If the output is:
NIL
NIL
0
then the command went fine.
Implemented to PUT files with sftp.
If *dry-run* is t, don’t actually run the LFTP command.
If *devel* is t, handle any error and re-signal it, so the developper gets the interactive debugger. When *devel* is NIL (the default), the error is logged on stderr.
LFTP profile.
:protocol
lftp-wrapper:*ftp-hostname*
:hostname
lftp-wrapper:*ftp-login*
:login
""
:server
The password is concealed. To see it, call ‘show-password’ on a profile.
""
:password
| Initarg | Value |
|---|---|
:protocol | sftp |
Return a path where FILENAME is located on the filesystem. By default, use FILENAME.
| Jump to: | (
B C E F G H L M P R S |
|---|
| Jump to: | (
B C E F G H L M P R S |
|---|
| Jump to: | *
C H L P S |
|---|
| Jump to: | *
C H L P S |
|---|
| Jump to: | C F L M P S |
|---|
| Jump to: | C F L M P S |
|---|