jimzah/freebsd-src
1
0
Fork 0
mirror of https://github.com/freebsd/freebsd-src.git synced 2024-12-01 21:33:04 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Document struct url.

Browse Source 
Document the default values for fetchStat*().
This commit is contained in:
Dag-Erling Smørgrav 2000-05-15 08:34:42 +00:00
parent 7a5b4b1ba6
commit 40ac28454e
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=60585
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
lib/libfetch/fetch.3
View File

@ -120,6 +120,28 @@ all URL schemes.
For instance, the file scheme only needs the <scheme>
and <document> components.
.Pp
.Fn fetchParseURL
returns a pointer to a
.Fa url
structure, which is defined as follows in
.Aq Pa fetch.h :
.Bd -literal
#define URL_SCHEMELEN 16
#define URL_USERLEN 256
#define URL_PWDLEN 256
struct url {
char scheme[URL_SCHEMELEN+1];
char user[URL_USERLEN+1];
char pwd[URL_PWDLEN+1];
char host[MAXHOSTNAMELEN+1];
int port;
char *doc;
off_t offset;
size_t length;
};
.Ed
.Pp
The pointer returned by
.Fn fetchParseURL
should be freed using
@ -156,6 +178,16 @@ struct url_stat {
};
.Ed
.Pp
If the size could not be obtained from the server, the
.Fa size
field is set to -1.
If the modification time could not be obtained from the server, the
.Fa mtime
field is set to the epoch.
If the access time could not be obtained from the server, the
.Fa atime
field is set to the modification time.
.Pp
.Fn fetchListURL
attempts to list the contents of the directory pointed to by the URL
provided.