vfs: pm_dumpcore: always clean up process
[minix.git] / lib / libfetch / fetch.cat3
blobf112d6a4591e4904dbced79b41f5ede783c263d1
1 FETCH(3)                NetBSD Library Functions Manual               FETCH(3)
3 N\bNA\bAM\bME\bE
4      f\bfe\bet\btc\bch\bhM\bMa\bak\bke\beU\bUR\bRL\bL, f\bfe\bet\btc\bch\bhP\bPa\bar\brs\bse\beU\bUR\bRL\bL, f\bfe\bet\btc\bch\bhC\bCo\bop\bpy\byU\bUR\bRL\bL, f\bfe\bet\btc\bch\bhF\bFr\bre\bee\beU\bUR\bRL\bL, f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\btU\bUR\bRL\bL,
5      f\bfe\bet\btc\bch\bhG\bGe\bet\btU\bUR\bRL\bL, f\bfe\bet\btc\bch\bhP\bPu\but\btU\bUR\bRL\bL, f\bfe\bet\btc\bch\bhS\bSt\bta\bat\btU\bUR\bRL\bL, f\bfe\bet\btc\bch\bhL\bLi\bis\bst\btU\bUR\bRL\bL, f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\bt,
6      f\bfe\bet\btc\bch\bhG\bGe\bet\bt, f\bfe\bet\btc\bch\bhP\bPu\but\bt, f\bfe\bet\btc\bch\bhS\bSt\bta\bat\bt, f\bfe\bet\btc\bch\bhL\bLi\bis\bst\bt, f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\btF\bFi\bil\ble\be, f\bfe\bet\btc\bch\bhG\bGe\bet\btF\bFi\bil\ble\be,
7      f\bfe\bet\btc\bch\bhP\bPu\but\btF\bFi\bil\ble\be, f\bfe\bet\btc\bch\bhS\bSt\bta\bat\btF\bFi\bil\ble\be, f\bfe\bet\btc\bch\bhL\bLi\bis\bst\btF\bFi\bil\ble\be, f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\btH\bHT\bTT\bTP\bP, f\bfe\bet\btc\bch\bhG\bGe\bet\btH\bHT\bTT\bTP\bP,
8      f\bfe\bet\btc\bch\bhP\bPu\but\btH\bHT\bTT\bTP\bP, f\bfe\bet\btc\bch\bhS\bSt\bta\bat\btH\bHT\bTT\bTP\bP, f\bfe\bet\btc\bch\bhL\bLi\bis\bst\btH\bHT\bTT\bTP\bP, f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\btF\bFT\bTP\bP, f\bfe\bet\btc\bch\bhG\bGe\bet\btF\bFT\bTP\bP,
9      f\bfe\bet\btc\bch\bhP\bPu\but\btF\bFT\bTP\bP, f\bfe\bet\btc\bch\bhS\bSt\bta\bat\btF\bFT\bTP\bP, f\bfe\bet\btc\bch\bhL\bLi\bis\bst\btF\bFT\bTP\bP f\bfe\bet\btc\bch\bhI\bIn\bni\bit\btU\bUR\bRL\bLL\bLi\bis\bst\bt,
10      f\bfe\bet\btc\bch\bhF\bFr\bre\bee\beU\bUR\bRL\bLL\bLi\bis\bst\bt, f\bfe\bet\btc\bch\bhU\bUn\bnq\bqu\buo\bot\bte\beP\bPa\bat\bth\bh, f\bfe\bet\btc\bch\bhU\bUn\bnq\bqu\buo\bot\bte\beF\bFi\bil\ble\ben\bna\bam\bme\be,
11      f\bfe\bet\btc\bch\bhS\bSt\btr\bri\bin\bng\bgi\bif\bfy\byU\bUR\bRL\bL, f\bfe\bet\btc\bch\bhC\bCo\bon\bnn\bne\bec\bct\bti\bio\bon\bnC\bCa\bac\bch\bhe\beI\bIn\bni\bit\bt, f\bfe\bet\btc\bch\bhC\bCo\bon\bnn\bne\bec\bct\bti\bio\bon\bnC\bCa\bac\bch\bhe\beC\bCl\blo\bos\bse\be,
12      f\bfe\bet\btc\bch\bh -- file transfer functions
14 L\bLI\bIB\bBR\bRA\bAR\bRY\bY
15                File Transfer Library for URLs (libfetch, -lfetch)
17 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
18      #\b#i\bin\bnc\bcl\blu\bud\bde\be <\b<s\bst\btd\bdi\bio\bo.\b.h\bh>\b>
19      #\b#i\bin\bnc\bcl\blu\bud\bde\be <\b<f\bfe\bet\btc\bch\bh.\b.h\bh>\b>
21      _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*
22      f\bfe\bet\btc\bch\bhM\bMa\bak\bke\beU\bUR\bRL\bL(_\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bs_\bc_\bh_\be_\bm_\be, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bh_\bo_\bs_\bt, _\bi_\bn_\bt _\bp_\bo_\br_\bt,
23          _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bd_\bo_\bc, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bu_\bs_\be_\br, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bp_\bw_\bd);
25      _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*
26      f\bfe\bet\btc\bch\bhP\bPa\bar\brs\bse\beU\bUR\bRL\bL(_\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bU_\bR_\bL);
28      _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*
29      f\bfe\bet\btc\bch\bhC\bCo\bop\bpy\byU\bUR\bRL\bL(_\bc_\bo_\bn_\bs_\bt _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu);
31      _\bv_\bo_\bi_\bd
32      f\bfe\bet\btc\bch\bhF\bFr\bre\bee\beU\bUR\bRL\bL(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu);
34      _\bf_\be_\bt_\bc_\bh_\bI_\bO _\b*
35      f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\btU\bUR\bRL\bL(_\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bU_\bR_\bL, _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl_\b__\bs_\bt_\ba_\bt _\b*_\bu_\bs, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
37      _\bf_\be_\bt_\bc_\bh_\bI_\bO _\b*
38      f\bfe\bet\btc\bch\bhG\bGe\bet\btU\bUR\bRL\bL(_\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bU_\bR_\bL, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
40      _\bf_\be_\bt_\bc_\bh_\bI_\bO _\b*
41      f\bfe\bet\btc\bch\bhP\bPu\but\btU\bUR\bRL\bL(_\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bU_\bR_\bL, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
43      _\bi_\bn_\bt
44      f\bfe\bet\btc\bch\bhS\bSt\bta\bat\btU\bUR\bRL\bL(_\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bU_\bR_\bL, _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl_\b__\bs_\bt_\ba_\bt _\b*_\bu_\bs, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
46      _\bi_\bn_\bt
47      f\bfe\bet\btc\bch\bhL\bLi\bis\bst\btU\bUR\bRL\bL(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl_\b__\bl_\bi_\bs_\bt _\b*_\bl_\bi_\bs_\bt, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bU_\bR_\bL, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
49      _\bf_\be_\bt_\bc_\bh_\bI_\bO _\b*
50      f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\bt(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu, _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl_\b__\bs_\bt_\ba_\bt _\b*_\bu_\bs, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
52      _\bf_\be_\bt_\bc_\bh_\bI_\bO _\b*
53      f\bfe\bet\btc\bch\bhG\bGe\bet\bt(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
55      _\bf_\be_\bt_\bc_\bh_\bI_\bO _\b*
56      f\bfe\bet\btc\bch\bhP\bPu\but\bt(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
58      _\bi_\bn_\bt
59      f\bfe\bet\btc\bch\bhS\bSt\bta\bat\bt(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu, _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl_\b__\bs_\bt_\ba_\bt _\b*_\bu_\bs, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
61      _\bi_\bn_\bt
62      f\bfe\bet\btc\bch\bhL\bLi\bis\bst\bt(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl_\b__\bl_\bi_\bs_\bt _\b*_\bl_\bi_\bs_\bt, _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
64      _\bf_\be_\bt_\bc_\bh_\bI_\bO _\b*
65      f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\btF\bFi\bil\ble\be(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu, _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl_\b__\bs_\bt_\ba_\bt _\b*_\bu_\bs, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
67      _\bf_\be_\bt_\bc_\bh_\bI_\bO _\b*
68      f\bfe\bet\btc\bch\bhG\bGe\bet\btF\bFi\bil\ble\be(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
70      _\bf_\be_\bt_\bc_\bh_\bI_\bO _\b*
71      f\bfe\bet\btc\bch\bhP\bPu\but\btF\bFi\bil\ble\be(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
73      _\bi_\bn_\bt
74      f\bfe\bet\btc\bch\bhS\bSt\bta\bat\btF\bFi\bil\ble\be(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu, _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl_\b__\bs_\bt_\ba_\bt _\b*_\bu_\bs, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
76      _\bi_\bn_\bt
77      f\bfe\bet\btc\bch\bhL\bLi\bis\bst\btF\bFi\bil\ble\be(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl_\b__\bl_\bi_\bs_\bt _\b*_\bl_\bi_\bs_\bt, _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
79      _\bf_\be_\bt_\bc_\bh_\bI_\bO _\b*
80      f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\btH\bHT\bTT\bTP\bP(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu, _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl_\b__\bs_\bt_\ba_\bt _\b*_\bu_\bs, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
82      _\bf_\be_\bt_\bc_\bh_\bI_\bO _\b*
83      f\bfe\bet\btc\bch\bhG\bGe\bet\btH\bHT\bTT\bTP\bP(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
85      _\bf_\be_\bt_\bc_\bh_\bI_\bO _\b*
86      f\bfe\bet\btc\bch\bhP\bPu\but\btH\bHT\bTT\bTP\bP(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
88      _\bi_\bn_\bt
89      f\bfe\bet\btc\bch\bhS\bSt\bta\bat\btH\bHT\bTT\bTP\bP(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu, _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl_\b__\bs_\bt_\ba_\bt _\b*_\bu_\bs, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
91      _\bi_\bn_\bt
92      f\bfe\bet\btc\bch\bhL\bLi\bis\bst\btH\bHT\bTT\bTP\bP(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl_\b__\bl_\bi_\bs_\bt _\b*_\bl_\bi_\bs_\bt, _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
94      _\bf_\be_\bt_\bc_\bh_\bI_\bO _\b*
95      f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\btF\bFT\bTP\bP(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu, _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl_\b__\bs_\bt_\ba_\bt _\b*_\bu_\bs, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
97      _\bf_\be_\bt_\bc_\bh_\bI_\bO _\b*
98      f\bfe\bet\btc\bch\bhG\bGe\bet\btF\bFT\bTP\bP(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
100      _\bf_\be_\bt_\bc_\bh_\bI_\bO _\b*
101      f\bfe\bet\btc\bch\bhP\bPu\but\btF\bFT\bTP\bP(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
103      _\bi_\bn_\bt
104      f\bfe\bet\btc\bch\bhS\bSt\bta\bat\btF\bFT\bTP\bP(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu, _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl_\b__\bs_\bt_\ba_\bt _\b*_\bu_\bs, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
106      _\bi_\bn_\bt
107      f\bfe\bet\btc\bch\bhL\bLi\bis\bst\btF\bFT\bTP\bP(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl_\b__\bl_\bi_\bs_\bt _\b*_\bl_\bi_\bs_\bt, _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu, _\bc_\bo_\bn_\bs_\bt _\bc_\bh_\ba_\br _\b*_\bf_\bl_\ba_\bg_\bs);
109      _\bv_\bo_\bi_\bd
110      f\bfe\bet\btc\bch\bhI\bIn\bni\bit\btU\bUR\bRL\bLL\bLi\bis\bst\bt(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl_\b__\bl_\bi_\bs_\bt _\b*_\bu_\bl);
112      _\bi_\bn_\bt
113      f\bfe\bet\btc\bch\bhA\bAp\bpp\bpe\ben\bnd\bdU\bUR\bRL\bLL\bLi\bis\bst\bt(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl_\b__\bl_\bi_\bs_\bt _\b*_\bd_\bs_\bt, _\bc_\bo_\bn_\bs_\bt _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl_\b__\bl_\bi_\bs_\bt _\b*_\bs_\br_\bc);
115      _\bv_\bo_\bi_\bd
116      f\bfe\bet\btc\bch\bhF\bFr\bre\bee\beU\bUR\bRL\bLL\bLi\bis\bst\bt(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl_\b__\bl_\bi_\bs_\bt _\b*_\bu_\bl);
118      _\bc_\bh_\ba_\br _\b*
119      f\bfe\bet\btc\bch\bhU\bUn\bnq\bqu\buo\bot\bte\beP\bPa\bat\bth\bh(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu);
121      _\bc_\bh_\ba_\br _\b*
122      f\bfe\bet\btc\bch\bhU\bUn\bnq\bqu\buo\bot\bte\beF\bFi\bil\ble\ben\bna\bam\bme\be(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu);
124      _\bc_\bh_\ba_\br _\b*
125      f\bfe\bet\btc\bch\bhS\bSt\btr\bri\bin\bng\bgi\bif\bfy\byU\bUR\bRL\bL(_\bc_\bo_\bn_\bs_\bt _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu);
127      _\bv_\bo_\bi_\bd
128      f\bfe\bet\btc\bch\bhC\bCo\bon\bnn\bne\bec\bct\bti\bio\bon\bnC\bCa\bac\bch\bhe\beI\bIn\bni\bit\bt(_\bi_\bn_\bt _\bg_\bl_\bo_\bb_\ba_\bl, _\bi_\bn_\bt _\bp_\be_\br_\b__\bh_\bo_\bs_\bt);
130      _\bv_\bo_\bi_\bd
131      f\bfe\bet\btc\bch\bhC\bCo\bon\bnn\bne\bec\bct\bti\bio\bon\bnC\bCa\bac\bch\bhe\beC\bCl\blo\bos\bse\be(_\bv_\bo_\bi_\bd);
133 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
134      These functions implement a high-level library for retrieving and upload-
135      ing files using Uniform Resource Locators (URLs).
137      f\bfe\bet\btc\bch\bhP\bPa\bar\brs\bse\beU\bUR\bRL\bL() takes a URL in the form of a null-terminated string and
138      splits it into its components function according to the Common Internet
139      Scheme Syntax detailed in RFC 1738.  A regular expression which produces
140      this syntax is:
142            <scheme>:(//(<user>(:<pwd>)?@)?<host>(:<port>)?)?/(<document>)?
144      If the URL does not seem to begin with a scheme name, it is assumed to be
145      a local path.  Only absolute path names are accepted.
147      Note that some components of the URL are not necessarily relevant to all
148      URL schemes.  For instance, the file scheme only needs the <scheme> and
149      <document> components.  f\bfe\bet\btc\bch\bhP\bPa\bar\brs\bse\beU\bUR\bRL\bL() quotes any unsafe character in
150      the URL automatically.  This is not done by f\bfe\bet\btc\bch\bhM\bMa\bak\bke\beU\bUR\bRL\bL().
151      f\bfe\bet\btc\bch\bhC\bCo\bop\bpy\byU\bUR\bRL\bL() copies an existing _\bu_\br_\bl structure.
153      f\bfe\bet\btc\bch\bhM\bMa\bak\bke\beU\bUR\bRL\bL(), f\bfe\bet\btc\bch\bhP\bPa\bar\brs\bse\beU\bUR\bRL\bL(), and f\bfe\bet\btc\bch\bhC\bCo\bop\bpy\byU\bUR\bRL\bL() return a pointer to a
154      _\bu_\br_\bl structure, which is defined as follows in <_\bf_\be_\bt_\bc_\bh_\b._\bh>:
156      #define URL_SCHEMELEN 16
157      #define URL_USERLEN 256
158      #define URL_PWDLEN 256
159      #define URL_HOSTLEN 255
161      struct url {
162          char         scheme[URL_SCHEMELEN + 1];
163          char         user[URL_USERLEN + 1];
164          char         pwd[URL_PWDLEN + 1];
165          char         host[URL_HOSTLEN + 1];
166          int          port;
167          char        *doc;
168          off_t        offset;
169          size_t       length;
170          time_t       last_modified;
171      };
173      The pointer returned by f\bfe\bet\btc\bch\bhM\bMa\bak\bke\beU\bUR\bRL\bL(), f\bfe\bet\btc\bch\bhC\bCo\bop\bpy\byU\bUR\bRL\bL(), and
174      f\bfe\bet\btc\bch\bhP\bPa\bar\brs\bse\beU\bUR\bRL\bL() should be freed using f\bfe\bet\btc\bch\bhF\bFr\bre\bee\beU\bUR\bRL\bL().  The size of _\bs_\bt_\br_\bu_\bc_\bt
175      _\bU_\bR_\bL is not part of the ABI.
177      f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\btU\bUR\bRL\bL(), f\bfe\bet\btc\bch\bhG\bGe\bet\btU\bUR\bRL\bL(), and f\bfe\bet\btc\bch\bhP\bPu\but\btU\bUR\bRL\bL() constitute the recom-
178      mended interface to the f\bfe\bet\btc\bch\bh library.  They examine the URL passed to
179      them to determine the transfer method, and call the appropriate lower-
180      level functions to perform the actual transfer.  f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\btU\bUR\bRL\bL() also
181      returns the remote document's metadata in the _\bu_\br_\bl_\b__\bs_\bt_\ba_\bt structure pointed
182      to by the _\bu_\bs argument.
184      The _\bf_\bl_\ba_\bg_\bs argument is a string of characters which specify transfer
185      options.  The meaning of the individual flags is scheme-dependent, and is
186      detailed in the appropriate section below.
188      f\bfe\bet\btc\bch\bhS\bSt\bta\bat\btU\bUR\bRL\bL() attempts to obtain the requested document's metadata and
189      fill in the structure pointed to by its second argument.  The _\bu_\br_\bl_\b__\bs_\bt_\ba_\bt
190      structure is defined as follows in <_\bf_\be_\bt_\bc_\bh_\b._\bh>:
192      struct url_stat {
193          off_t        size;
194          time_t       atime;
195          time_t       mtime;
196      };
198      If the size could not be obtained from the server, the _\bs_\bi_\bz_\be field is set
199      to -1.  If the modification time could not be obtained from the server,
200      the _\bm_\bt_\bi_\bm_\be field is set to the epoch.  If the access time could not be
201      obtained from the server, the _\ba_\bt_\bi_\bm_\be field is set to the modification
202      time.
204      f\bfe\bet\btc\bch\bhL\bLi\bis\bst\btU\bUR\bRL\bL() attempts to list the contents of the directory pointed to
205      by the URL provided.  The pattern can be a simple glob-like expression as
206      hint.  Callers should not depend on the server to filter names.  If suc-
207      cessful, it appends the list of entries to the _\bu_\br_\bl_\b__\bl_\bi_\bs_\bt structure.  The
208      _\bu_\br_\bl_\b__\bl_\bi_\bs_\bt structure is defined as follows in <_\bf_\be_\bt_\bc_\bh_\b._\bh>:
210      struct url_list {
211          size_t      length;
212          size_t      alloc_size;
213          struct url  *urls;
214      };
216      The list should be initialized by calling f\bfe\bet\btc\bch\bhI\bIn\bni\bit\btU\bUR\bRL\bLL\bLi\bis\bst\bt() and the
217      entries be freed by calling f\bfe\bet\btc\bch\bhF\bFr\bre\bee\beU\bUR\bRL\bLL\bLi\bis\bst\bt().  The function
218      f\bfe\bet\btc\bch\bhA\bAp\bpp\bpe\ben\bnd\bdU\bUR\bRL\bLL\bLi\bis\bst\bt() can be used to append one URL lists to another.  If
219      the `c' (cache result) flag is specified, the library is allowed to
220      internally cache the result.
222      f\bfe\bet\btc\bch\bhS\bSt\btr\bri\bin\bng\bgi\bif\bfy\byU\bUR\bRL\bL() returns the URL as string.  f\bfe\bet\btc\bch\bhU\bUn\bnq\bqu\buo\bot\bte\beP\bPa\bat\bth\bh()
223      returns the path name part of the URL with any quoting undone.  Query
224      arguments and fragment identifiers are not included.
225      f\bfe\bet\btc\bch\bhU\bUn\bnq\bqu\buo\bot\bte\beF\bFi\bil\ble\ben\bna\bam\bme\be() returns the last component of the path name as
226      returned by f\bfe\bet\btc\bch\bhU\bUn\bnq\bqu\buo\bot\bte\beP\bPa\bat\bth\bh().  f\bfe\bet\btc\bch\bhS\bSt\btr\bri\bin\bng\bgi\bif\bfy\byU\bUR\bRL\bL(), f\bfe\bet\btc\bch\bhU\bUn\bnq\bqu\buo\bot\bte\beP\bPa\bat\bth\bh(),
227      and f\bfe\bet\btc\bch\bhU\bUn\bnq\bqu\buo\bot\bte\beF\bFi\bil\ble\ben\bna\bam\bme\be() return a string that should be deallocated
228      with f\bfr\bre\bee\be() after use.
230      f\bfe\bet\btc\bch\bhC\bCo\bon\bnn\bne\bec\bct\bti\bio\bon\bnC\bCa\bac\bch\bhe\beI\bIn\bni\bit\bt() enables the connection cache.  The first argu-
231      ment specifies the global limit on cached connections.  The second argu-
232      ment specifies the host limit.  Entries are considered to specify the
233      same host, if the host name from the URL is identical, indepent of the
234      address or address family.  f\bfe\bet\btc\bch\bhC\bCo\bon\bnn\bne\bec\bct\bti\bio\bon\bnC\bCa\bac\bch\bhe\beC\bCl\blo\bos\bse\be() flushed the con-
235      nection cache and closes all cached connections.
237      f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\bt(), f\bfe\bet\btc\bch\bhG\bGe\bet\bt(), f\bfe\bet\btc\bch\bhP\bPu\but\bt(), and f\bfe\bet\btc\bch\bhS\bSt\bta\bat\bt() are similar to
238      f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\btU\bUR\bRL\bL(), f\bfe\bet\btc\bch\bhG\bGe\bet\btU\bUR\bRL\bL(), f\bfe\bet\btc\bch\bhP\bPu\but\btU\bUR\bRL\bL(), and f\bfe\bet\btc\bch\bhS\bSt\bta\bat\btU\bUR\bRL\bL(), except
239      that they expect a pre-parsed URL in the form of a pointer to a _\bs_\bt_\br_\bu_\bc_\bt
240      _\bu_\br_\bl rather than a string.
242      All of the f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\btX\bXX\bXX\bX(), f\bfe\bet\btc\bch\bhG\bGe\bet\btX\bXX\bXX\bX(), and f\bfe\bet\btc\bch\bhP\bPu\but\btX\bXX\bXX\bX() functions
243      return a pointer to a stream which can be used to read or write data from
244      or to the requested document, respectively.  Note that although the
245      implementation details of the individual access methods vary, it can gen-
246      erally be assumed that a stream returned by one of the f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\btX\bXX\bXX\bX() or
247      f\bfe\bet\btc\bch\bhG\bGe\bet\btX\bXX\bXX\bX() functions is read-only, and that a stream returned by one
248      of the f\bfe\bet\btc\bch\bhP\bPu\but\btX\bXX\bXX\bX() functions is write-only.
250 P\bPR\bRO\bOT\bTO\bOC\bCO\bOL\bL I\bIN\bND\bDE\bEP\bPE\bEN\bND\bDE\bEN\bNT\bT F\bFL\bLA\bAG\bGS\bS
251      If the `i' (if-modified-since) flag is specified, the library will try to
252      fetch the content only if it is newer than _\bl_\ba_\bs_\bt_\b__\bm_\bo_\bd_\bi_\bf_\bi_\be_\bd.  For HTTP an
253      If-Modified-Since HTTP header is sent.  For FTP a MTDM command is sent
254      first and compared locally.  For FILE the source file is compared.
256 F\bFI\bIL\bLE\bE S\bSC\bCH\bHE\bEM\bME\bE
257      f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\btF\bFi\bil\ble\be(), f\bfe\bet\btc\bch\bhG\bGe\bet\btF\bFi\bil\ble\be(), and f\bfe\bet\btc\bch\bhP\bPu\but\btF\bFi\bil\ble\be() provide access to
258      documents which are files in a locally mounted file system.  Only the
259      <document> component of the URL is used.
261      f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\btF\bFi\bil\ble\be() and f\bfe\bet\btc\bch\bhG\bGe\bet\btF\bFi\bil\ble\be() do not accept any flags.
263      f\bfe\bet\btc\bch\bhP\bPu\but\btF\bFi\bil\ble\be() accepts the `a' (append to file) flag.  If that flag is
264      specified, the data written to the stream returned by f\bfe\bet\btc\bch\bhP\bPu\but\btF\bFi\bil\ble\be() will
265      be appended to the previous contents of the file, instead of replacing
266      them.
268 F\bFT\bTP\bP S\bSC\bCH\bHE\bEM\bME\bE
269      f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\btF\bFT\bTP\bP(), f\bfe\bet\btc\bch\bhG\bGe\bet\btF\bFT\bTP\bP(), and f\bfe\bet\btc\bch\bhP\bPu\but\btF\bFT\bTP\bP() implement the FTP proto-
270      col as described in RFC 959.
272      By default l\bli\bib\bbf\bfe\bet\btc\bch\bh will attempt to use passive mode first and only fall-
273      back to active mode if the server reports a syntax error.  If the `a'
274      (active) flag is specified, a passive connection is not tried and active
275      mode is used directly.
277      If the `l' (low) flag is specified, data sockets will be allocated in the
278      low (or default) port range instead of the high port range (see ip(4)).
280      If the `d' (direct) flag is specified, f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\btF\bFT\bTP\bP(), f\bfe\bet\btc\bch\bhG\bGe\bet\btF\bFT\bTP\bP(), and
281      f\bfe\bet\btc\bch\bhP\bPu\but\btF\bFT\bTP\bP() will use a direct connection even if a proxy server is
282      defined.
284      If no user name or password is given, the f\bfe\bet\btc\bch\bh library will attempt an
285      anonymous login, with user name "anonymous" and password "anony-
286      mous@<hostname>".
288 H\bHT\bTT\bTP\bP S\bSC\bCH\bHE\bEM\bME\bE
289      The f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\btH\bHT\bTT\bTP\bP(), f\bfe\bet\btc\bch\bhG\bGe\bet\btH\bHT\bTT\bTP\bP(), and f\bfe\bet\btc\bch\bhP\bPu\but\btH\bHT\bTT\bTP\bP() functions imple-
290      ment the HTTP/1.1 protocol.  With a little luck, there is even a chance
291      that they comply with RFC 2616 and RFC 2617.
293      If the `d' (direct) flag is specified, f\bfe\bet\btc\bch\bhX\bXG\bGe\bet\btH\bHT\bTT\bTP\bP(), f\bfe\bet\btc\bch\bhG\bGe\bet\btH\bHT\bTT\bTP\bP(),
294      and f\bfe\bet\btc\bch\bhP\bPu\but\btH\bHT\bTT\bTP\bP() will use a direct connection even if a proxy server is
295      defined.
297      Since there seems to be no good way of implementing the HTTP PUT method
298      in a manner consistent with the rest of the f\bfe\bet\btc\bch\bh library, f\bfe\bet\btc\bch\bhP\bPu\but\btH\bHT\bTT\bTP\bP()
299      is currently unimplemented.
301 A\bAU\bUT\bTH\bHE\bEN\bNT\bTI\bIC\bCA\bAT\bTI\bIO\bON\bN
302      Apart from setting the appropriate environment variables and specifying
303      the user name and password in the URL or the _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl, the calling pro-
304      gram has the option of defining an authentication function with the fol-
305      lowing prototype:
307      _\bi_\bn_\bt m\bmy\byA\bAu\but\bth\bhM\bMe\bet\bth\bho\bod\bd(_\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl _\b*_\bu)
309      The callback function should fill in the _\bu_\bs_\be_\br and _\bp_\bw_\bd fields in the pro-
310      vided _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl and return 0 on success, or any other value to indicate
311      failure.
313      To register the authentication callback, simply set _\bf_\be_\bt_\bc_\bh_\bA_\bu_\bt_\bh_\bM_\be_\bt_\bh_\bo_\bd to
314      point at it.  The callback will be used whenever a site requires authen-
315      tication and the appropriate environment variables are not set.
317      This interface is experimental and may be subject to change.
319 R\bRE\bET\bTU\bUR\bRN\bN V\bVA\bAL\bLU\bUE\bES\bS
320      f\bfe\bet\btc\bch\bhP\bPa\bar\brs\bse\beU\bUR\bRL\bL() returns a pointer to a _\bs_\bt_\br_\bu_\bc_\bt _\bu_\br_\bl containing the individ-
321      ual components of the URL.  If it is unable to allocate memory, or the
322      URL is syntactically incorrect, f\bfe\bet\btc\bch\bhP\bPa\bar\brs\bse\beU\bUR\bRL\bL() returns a NULL pointer.
324      The f\bfe\bet\btc\bch\bhS\bSt\bta\bat\bt() functions return 0 on success and -1 on failure.
326      All other functions return a stream pointer which may be used to access
327      the requested document, or NULL if an error occurred.
329      The following error codes are defined in <_\bf_\be_\bt_\bc_\bh_\b._\bh>:
331      [FETCH_ABORT]       Operation aborted
333      [FETCH_AUTH]        Authentication failed
335      [FETCH_DOWN]        Service unavailable
337      [FETCH_EXISTS]      File exists
339      [FETCH_FULL]        File system full
341      [FETCH_INFO]        Informational response
343      [FETCH_MEMORY]      Insufficient memory
345      [FETCH_MOVED]       File has moved
347      [FETCH_NETWORK]     Network error
349      [FETCH_OK]          No error
351      [FETCH_PROTO]       Protocol error
353      [FETCH_RESOLV]      Resolver error
355      [FETCH_SERVER]      Server error
357      [FETCH_TEMP]        Temporary error
359      [FETCH_TIMEOUT]     Operation timed out
361      [FETCH_UNAVAIL]     File is not available
363      [FETCH_UNKNOWN]     Unknown error
365      [FETCH_URL]         Invalid URL
367      The accompanying error message includes a protocol-specific error code
368      and message, e.g. "File is not available (404 Not Found)"
370 E\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT
371      FETCH_BIND_ADDRESS  Specifies a host name or IP address to which sockets
372                          used for outgoing connections will be bound.
374      FTP_LOGIN           Default FTP login if none was provided in the URL.
376      FTP_PASSIVE_MODE    If set to anything but `no', forces the FTP code to
377                          use passive mode.
379      FTP_PASSWORD        Default FTP password if the remote server requests
380                          one and none was provided in the URL.
382      FTP_PROXY           URL of the proxy to use for FTP requests.  The docu-
383                          ment part is ignored.  FTP and HTTP proxies are sup-
384                          ported; if no scheme is specified, FTP is assumed.
385                          If the proxy is an FTP proxy, l\bli\bib\bbf\bfe\bet\btc\bch\bh will send
386                          `user@host' as user name to the proxy, where `user'
387                          is the real user name, and `host' is the name of the
388                          FTP server.
390                          If this variable is set to an empty string, no proxy
391                          will be used for FTP requests, even if the HTTP_PROXY
392                          variable is set.
394      ftp_proxy           Same as FTP_PROXY, for compatibility.
396      HTTP_AUTH           Specifies HTTP authorization parameters as a colon-
397                          separated list of items.  The first and second item
398                          are the authorization scheme and realm respectively;
399                          further items are scheme-dependent.  Currently, only
400                          basic authorization is supported.
402                          Basic authorization requires two parameters: the user
403                          name and password, in that order.
405                          This variable is only used if the server requires
406                          authorization and no user name or password was speci-
407                          fied in the URL.
409      HTTP_PROXY          URL of the proxy to use for HTTP requests.  The docu-
410                          ment part is ignored.  Only HTTP proxies are sup-
411                          ported for HTTP requests.  If no port number is spec-
412                          ified, the default is 3128.
414                          Note that this proxy will also be used for FTP docu-
415                          ments, unless the FTP_PROXY variable is set.
417      http_proxy          Same as HTTP_PROXY, for compatibility.
419      HTTP_PROXY_AUTH     Specifies authorization parameters for the HTTP proxy
420                          in the same format as the HTTP_AUTH variable.
422                          This variable is used if and only if connected to an
423                          HTTP proxy, and is ignored if a user and/or a pass-
424                          word were specified in the proxy URL.
426      HTTP_REFERER        Specifies the referrer URL to use for HTTP requests.
427                          If set to ``auto'', the document URL will be used as
428                          referrer URL.
430      HTTP_USER_AGENT     Specifies the User-Agent string to use for HTTP
431                          requests.  This can be useful when working with HTTP
432                          origin or proxy servers that differentiate between
433                          user agents.
435      NETRC               Specifies a file to use instead of _\b~_\b/_\b._\bn_\be_\bt_\br_\bc to look
436                          up login names and passwords for FTP sites.  See
437                          ftp(1) for a description of the file format.  This
438                          feature is experimental.
440      NO_PROXY            Either a single asterisk, which disables the use of
441                          proxies altogether, or a comma- or whitespace-sepa-
442                          rated list of hosts for which proxies should not be
443                          used.
445      no_proxy            Same as NO_PROXY, for compatibility.
447 E\bEX\bXA\bAM\bMP\bPL\bLE\bES\bS
448      To access a proxy server on _\bp_\br_\bo_\bx_\by_\b._\be_\bx_\ba_\bm_\bp_\bl_\be_\b._\bc_\bo_\bm port 8080, set the
449      HTTP_PROXY environment variable in a manner similar to this:
451            HTTP_PROXY=http://proxy.example.com:8080
453      If the proxy server requires authentication, there are two options avail-
454      able for passing the authentication data.  The first method is by using
455      the proxy URL:
457            HTTP_PROXY=http://<user>:<pwd>@proxy.example.com:8080
459      The second method is by using the HTTP_PROXY_AUTH environment variable:
461            HTTP_PROXY=http://proxy.example.com:8080
462            HTTP_PROXY_AUTH=basic:*:<user>:<pwd>
464      To disable the use of a proxy for an HTTP server running on the local
465      host, define NO_PROXY as follows:
467            NO_PROXY=localhost,127.0.0.1
469 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
470      ftp(1), ip(4)
472      J. Postel and J. K. Reynolds, _\bF_\bi_\bl_\be _\bT_\br_\ba_\bn_\bs_\bf_\be_\br _\bP_\br_\bo_\bt_\bo_\bc_\bo_\bl, October 1985, RFC
473      959.
475      P. Deutsch, A. Emtage, and A. Marine, _\bH_\bo_\bw _\bt_\bo _\bU_\bs_\be _\bA_\bn_\bo_\bn_\by_\bm_\bo_\bu_\bs _\bF_\bT_\bP, May 1994,
476      RFC 1635.
478      T. Berners-Lee, L. Masinter, and M. McCahill, _\bU_\bn_\bi_\bf_\bo_\br_\bm _\bR_\be_\bs_\bo_\bu_\br_\bc_\be _\bL_\bo_\bc_\ba_\bt_\bo_\br_\bs
479      _\b(_\bU_\bR_\bL_\b), December 1994, RFC 1738.
481      R. Fielding, J. Gettys, J. Mogul, H. Frystyk, L. Masinter, P. Leach, and
482      T. Berners-Lee, _\bH_\by_\bp_\be_\br_\bt_\be_\bx_\bt _\bT_\br_\ba_\bn_\bs_\bf_\be_\br _\bP_\br_\bo_\bt_\bo_\bc_\bo_\bl _\b-_\b- _\bH_\bT_\bT_\bP_\b/_\b1_\b._\b1, January 1999,
483      RFC 2616.
485      J. Franks, P. Hallam-Baker, J. Hostetler, S. Lawrence, P. Leach, A.
486      Luotonen, and L. Stewart, _\bH_\bT_\bT_\bP _\bA_\bu_\bt_\bh_\be_\bn_\bt_\bi_\bc_\ba_\bt_\bi_\bo_\bn_\b: _\bB_\ba_\bs_\bi_\bc _\ba_\bn_\bd _\bD_\bi_\bg_\be_\bs_\bt _\bA_\bc_\bc_\be_\bs_\bs
487      _\bA_\bu_\bt_\bh_\be_\bn_\bt_\bi_\bc_\ba_\bt_\bi_\bo_\bn, June 1999, RFC 2617.
489 H\bHI\bIS\bST\bTO\bOR\bRY\bY
490      The f\bfe\bet\btc\bch\bh library first appeared in FreeBSD 3.0.
492 A\bAU\bUT\bTH\bHO\bOR\bRS\bS
493      The f\bfe\bet\btc\bch\bh library was mostly written by Dag-Erling Smørgrav
494      <des@FreeBSD.org> with numerous suggestions from Jordan K. Hubbard
495      <jkh@FreeBSD.org>, Eugene Skepner <eu@qub.com> and other FreeBSD develop-
496      ers.  It replaces the older f\bft\btp\bpi\bio\bo library written by Poul-Henning Kamp
497      <phk@FreeBSD.org> and Jordan K. Hubbard <jkh@FreeBSD.org>.
499      This manual page was written by Dag-Erling Smørgrav <des@FreeBSD.org>.
501 B\bBU\bUG\bGS\bS
502      Some parts of the library are not yet implemented.  The most notable
503      examples of this are f\bfe\bet\btc\bch\bhP\bPu\but\btH\bHT\bTT\bTP\bP() and FTP proxy support.
505      There is no way to select a proxy at run-time other than setting the
506      HTTP_PROXY or FTP_PROXY environment variables as appropriate.
508      l\bli\bib\bbf\bfe\bet\btc\bch\bh does not understand or obey 305 (Use Proxy) replies.
510      Error numbers are unique only within a certain context; the error codes
511      used for FTP and HTTP overlap, as do those used for resolver and system
512      errors.  For instance, error code 202 means "Command not implemented,
513      superfluous at this site" in an FTP context and "Accepted" in an HTTP
514      context.
516      f\bfe\bet\btc\bch\bhS\bSt\bta\bat\btF\bFT\bTP\bP() does not check that the result of an MDTM command is a
517      valid date.
519      The man page is incomplete, poorly written and produces badly formatted
520      text.
522      The error reporting mechanism is unsatisfactory.
524      Some parts of the code are not fully reentrant.
526 NetBSD 5.0                     January 22, 2010                     NetBSD 5.0