mirror of
https://github.com/libssh2/libssh2.git
synced 2025-10-24 14:53:03 +03:00
b889b39945
To render in Git webviews as-is, to make it easier to edit, verify,
and to sync up with curl.
- add options to not build the `.3` man pages:
- autotools: `--disable-docs`
- cmake: `LIBSSH2_BUILD_DOCS=OFF`
- building `.3` man pages requires Perl after this patch.
- drop `mansyntax` and the shell / `grep` / GNU `man` tool requirements with it.
- scripts and most logic were copied from curl.
- add `cd2nroff` from curl, with edits to relax curl-specific checks.
- used `nroff2cd` (from curl) to convert from `.3` to `.md`. Then
manually fixed copyrights, inline function references and a couple
of other things.
Credits-to: Daniel Stenberg
Ref: eefcc1bda4
Ref: https://github.com/curl/curl/pull/12730
Ref: https://github.com/libssh2/www/issues/25#issuecomment-3289431671
Closes #1660
72 lines
2.0 KiB
Markdown
72 lines
2.0 KiB
Markdown
---
|
|
c: Copyright (C) The libssh2 project and its contributors.
|
|
SPDX-License-Identifier: BSD-3-Clause
|
|
Title: libssh2_sftp_posix_rename_ex
|
|
Section: 3
|
|
Source: libssh2
|
|
See-also:
|
|
- libssh2_sftp_init(3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
libssh2_sftp_posix_rename_ex - rename an SFTP file using POSIX semantics
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <libssh2.h>
|
|
#include <libssh2_sftp.h>
|
|
|
|
int
|
|
libssh2_sftp_posix_rename_ex(LIBSSH2_SFTP *sftp,
|
|
const char *source_filename,
|
|
size_t source_filename_len,
|
|
const char *dest_filename,
|
|
size_t dest_filename_len);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
*sftp* - SFTP instance as returned by libssh2_sftp_init(3)
|
|
|
|
*sourcefile* - Path and name of the existing filesystem entry
|
|
|
|
*sourcefile_len* - Length of the path and name of the existing
|
|
filesystem entry
|
|
|
|
*destfile* - Path and name of the target filesystem entry
|
|
|
|
*destfile_len* - Length of the path and name of the target
|
|
filesystem entry
|
|
|
|
This function implements the posix-rename@openssh.com extension, which is
|
|
useful when, for example, moving files across filesystems on a remote server.
|
|
SSH_FXP_RENAME does not specify a specific implementation, but many servers
|
|
will attempt to user hard links when moving files using SSH_FXP_RENAME.
|
|
|
|
If the server does not support posix-rename@openssh.com, this function will
|
|
return LIBSSH2_FX_OP_UNSUPPORTED and you can call libssh2_sftp_rename_ex (3) as
|
|
a backup.
|
|
|
|
# RETURN VALUE
|
|
|
|
Return 0 on success or negative on failure. It returns
|
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
|
|
|
# ERRORS
|
|
|
|
*LIBSSH2_FX_OP_UNSUPPORTED* - Server does not support
|
|
posix-rename@openssh.com
|
|
|
|
*LIBSSH2_ERROR_ALLOC* - An internal memory allocation call failed.
|
|
|
|
*LIBSSH2_ERROR_SOCKET_SEND* - Unable to send data on socket.
|
|
|
|
*LIBSSH2_ERROR_SOCKET_TIMEOUT* -
|
|
|
|
*LIBSSH2_ERROR_SFTP_PROTOCOL* - An invalid SFTP protocol response was
|
|
received on the socket, or an SFTP operation caused an errorcode to
|
|
be returned by the server.
|