diff options
| -rw-r--r-- | lib/libftpio/ftpio.3 | 50 | ||||
| -rw-r--r-- | lib/libnetgraph/netgraph.3 | 51 |
2 files changed, 67 insertions, 34 deletions
diff --git a/lib/libftpio/ftpio.3 b/lib/libftpio/ftpio.3 index 72445a6..5f3fd01 100644 --- a/lib/libftpio/ftpio.3 +++ b/lib/libftpio/ftpio.3 @@ -83,8 +83,9 @@ .Sh DESCRIPTION These functions implement a high-level library for managing FTP connections. .Pp +The .Fn ftpLogin -attempts to log in using the supplied +function attempts to log in using the supplied .Fa user , .Fa passwd , .Fa ftp_port @@ -99,19 +100,23 @@ On failure, NULL is returned and .Fa retcode will have the error code returned by the foreign server. .Pp +The .Fn ftpChdir -attempts to issue a server CD command to the directory named in +function attempts to issue a server CD command to the directory named in .Fa dir . On success, zero is returned. On failure, the error code from the server. .Pp +The .Fn ftpErrno -returns the server failure code for the last operation (useful for seeing -more about what happened if you're familiar with FTP error codes). +function returns the server failure code for the last operation (useful for +seeing more about what happened if you're familiar with FTP error codes). +The .Fn ftpErrString -returns a human readable version of the supplied server failure code. +function returns a human readable version of the supplied server failure code. .Pp +The .Fn ftpGet -attempts to retrieve the file named by the +function attempts to retrieve the file named by the .Fa file argument (which is assumed to be relative to the FTP server's current directory, see @@ -128,18 +133,21 @@ of .Fa *seekto will be zero'd. .Pp +The .Fn ftpGetModtime -returns the last modification time of the file named by the +function returns the last modification time of the file named by the .Fa file argument. If the file could not be opened or stat'd, 0 is returned. .Pp +The .Fn ftpGetSize -returns the size in bytes of the file named by the +function returns the size in bytes of the file named by the .Fa file argument. If the file could not be opened or stat'd, -1 is returned. .Pp +The .Fn ftpPut -attempts to create a new file named by the +function attempts to create a new file named by the .Fa file argument (which is assumed to be relative to the FTP server's current directory, see @@ -148,28 +156,36 @@ and returns a new .Fa stream pointer for the file or NULL on failure. .Pp +The .Fn ftpAscii -sets ASCII mode for the current server connection named by +function sets +.Tn ASCII +mode for the current server connection named by .Fa stream . .Pp +The .Fn ftpBinary -sets binary mode for the current server connection named by +function sets binary mode for the current server connection named by .Fa stream . .Pp +The .Fn ftpPassive -sets passive mode (for firewalls) for the current server connection named by +function sets passive mode (for firewalls) for the current server connection +named by .Fa stream to boolean value .Fa status . .Pp +The .Fn ftpVerbose -sets the verbosity mode for the current server connection named by +function sets the verbosity mode for the current server connection named by .Fa stream to boolean value .Fa status . .Pp +The .Fn ftpGetURL -attempts to retrieve the file named by the supplied +function attempts to retrieve the file named by the supplied .Fa URL and can be considered equivalent to the combined .Fn ftpLogin , @@ -182,8 +198,9 @@ is ever returned - the connection to the server closes when the file has been completely read. Use the lower-level routines if multiple gets are required as it will be far more efficient. .Pp +The .Fn ftpPutURL -attempts to create the file named by the supplied +function attempts to create the file named by the supplied .Fa URL and can be considered equivalent to the combined .Fn ftpLogin , @@ -195,10 +212,11 @@ to the server closes when the file has been completely written. Use the lower-level routines if multiple puts are required as it will be far more efficient. .Pp +The .Fn ftpLoginAf , .Fn ftpGetURLAf , .Fn ftpPutURLAf -are same as +functions are same as .Fn ftpLogin , .Fn ftpGetURL , .Fn ftpPutURL diff --git a/lib/libnetgraph/netgraph.3 b/lib/libnetgraph/netgraph.3 index e9922f6..f847701 100644 --- a/lib/libnetgraph/netgraph.3 +++ b/lib/libnetgraph/netgraph.3 @@ -82,30 +82,35 @@ graph-based networking system, by utilizing the netgraph node type (see .Xr ng_socket 4 ) . .Pp +The .Fn NgMkSockNode -should be called first, to create a new +function should be called first, to create a new .Em socket type netgraph node with associated control and data sockets. If .Fa name is non-NULL, the node will have that global name assigned to it. -.Fa "*csp" +The +.Fa "csp" and -.Fa "*dsp" -will be set to the newly opened control and data sockets +.Fa "dsp" +arguments will be set to the newly opened control and data sockets associated with the node; either .Fa "csp" or .Fa "dsp" may be NULL if only one socket is desired. +The .Fn NgMkSockNode -loads the socket node type KLD if it's not already loaded. +function loads the socket node type KLD if it's not already loaded. .Pp +The .Fn NgNameNode -assigns a global name to the node addressed by +function assigns a global name to the node addressed by .Fa path . .Pp +The .Fn NgSendMsg -sends a binary control message from the socket node associated +function sends a binary control message from the socket node associated with control socket .Fa cs to the node addressed by @@ -133,14 +138,16 @@ to send reply to a previously received control message. The original message header should be pointed to by .Fa msg . .Pp +The .Fn NgSendAsciiMsg -performs the same function as +function performs the same function as .Fn NgSendMsg , but adds support for .Tn ASCII encoding of control messages. +The .Fn NgSendAsciiMsg -formats its input a la +function formats its input a la .Xr printf 3 and then sends the resulting .Tn ASCII @@ -156,8 +163,9 @@ Note that .Tn ASCII conversion may not be supported by all node types. .Pp +The .Fn NgRecvMsg -reads the next control message received by the node associated with +function reads the next control message received by the node associated with control socket .Fa cs . The message and any extra argument data must fit in @@ -173,8 +181,9 @@ the node from which the message was received. The length of the control message is returned. A return value of zero indicates that the socket was closed. .Pp +The .Fn NgRecvAsciiMsg -works exactly like +function works exactly like .Fn NgRecvMsg , except that after the message is received, any binary arguments are converted to @@ -189,14 +198,16 @@ a NUL-terminated version of the arguments (and the reply header argument length field will be adjusted). .Pp +The .Fn NgSendData -writes a data packet out on the specified hook of the node corresponding -to data socket +function writes a data packet out on the specified hook of the node +corresponding to data socket .Fa ds . The node must already be connected to some other node via that hook. .Pp +The .Fn NgRecvData -reads the next data packet (of up to +function reads the next data packet (of up to .Fa len bytes) received by the node corresponding to data socket .Fa ds @@ -212,12 +223,14 @@ the hook on which the data was received. The length of the packet is returned. A return value of zero indicates that the socket was closed. .Pp +The .Fn NgSetDebug and .Fn NgSetErrLog -are used for debugging. +functions are used for debugging. +The .Fn NgSetDebug -sets the debug level (if non-negative), and returns the old setting. +function sets the debug level (if non-negative), and returns the old setting. Higher debug levels result in more verbosity. The default is zero. All debug and error messages are logged via the functions specified in the most recent call to @@ -256,10 +269,12 @@ and KLD modules must have been loaded via .Xr kldload 8 . .Sh RETURN VALUES +The .Fn NgSetDebug -returns the previous debug setting. +function returns the previous debug setting. +The .Fn NgSetErrLog -has no return value. +function has no return value. All other functions return \-1 if there was an error and set .Va errno accordingly. |
