usr/src/lib/libast/common/man/mime.3

   1 .fp 5 CW
   2 .de Af
   3 .ds ;G \\*(;G\\f\\$1\\$3\\f\\$2
   4 .if !\a\\$4\a\a .Af \\$2 \\$1 "\\$4" "\\$5" "\\$6" "\\$7" "\\$8" "\\$9"
   5 ..
   6 .de aF
   7 .ie \a\\$3\a\a .ft \\$1
   8 .el \{\
   9 .ds ;G \&
  10 .nr ;G \\n(.f
  11 .Af "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" "\\$7" "\\$8" "\\$9"
  12 \\*(;G
  13 .ft \\n(;G \}
  14 ..
  15 .de L
  16 .aF 5 \\n(.f "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" "\\$7"
  17 ..
  18 .de LR
  19 .aF 5 1 "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" "\\$7"
  20 ..
  21 .de RL
  22 .aF 1 5 "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" "\\$7"
  23 ..
  24 .de EX          \" start example
  25 .ta 1i 2i 3i 4i 5i 6i
  26 .PP
  27 .RS
  28 .PD 0
  29 .ft 5
  30 .nf
  31 ..
  32 .de EE          \" end example
  33 .fi
  34 .ft
  35 .PD
  36 .RE
  37 .PP
  38 ..
  39 .TH MIME 3
  40 .SH NAME
  41 mime \- mime/mailcap interface
  42 .SH SYNOPSIS
  43 .EX
  44 #include <mime.h>
  45
  46 Mime_t
  47 {
  48         unsigned long   flags;
  49 };
  50
  51 Mime_t*   mimeopen(unsigned long \fIflags\fP);
  52 void      mimeclose(Mime_t* \fImime\fP);
  53
  54 int       mimeload(Mime_t* \fImime\fP, const char* \fIpath\fP, unsigned long \fIflags\fP);
  55 int       mimelist(Mime_t* \fImime\fP, Sfio_t* \fIsp\fP, const char* \fIpattern\fP);
  56
  57 char*     mimeview(Mime_t* \fImime\fP, const char* \fIview\fP, const char* \fIname\fP, const char* \fItype\fP, const char* \fIopts\fP);
  58 int       mimeset(Mime_t* \fImime\fP, char* \fIline\fP, unsigned long \fIflags\fP);
  59 .EE
  60 .SH DESCRIPTION
  61 These routines provide an interface to the MIME type database.
  62 .L mimeopen
  63 returns a mime session handle that is passed to all of the other routines.
  64 The
  65 .I flags
  66 argument is currently unused.
  67 .PP
  68 .L mimeclose
  69 closes the mime session.
  70 .PP
  71 .L mimeload
  72 loads the mime file named by
  73 .I path
  74 into the mime session.
  75 .I flags
  76 may be one of:
  77 .TP
  78 .L MIME_LIST
  79 The
  80 .I path
  81 argument is a
  82 .B :
  83 separated list of pathnames, each of which is loaded.
  84 Non-existent files are ignored
  85 .L MIME_LIST
  86 set.
  87 .TP
  88 .L MIME_REPLACE
  89 Replace existing entries by new entries with the same type.
  90 Otherwise original entries take precedence.
  91 .PP
  92 More than one mime file can be loaded into a session;
  93 the files are searched in load order.
  94 If
  95 .I path
  96 is
  97 .L 0
  98 then the default mime file is loaded.
  99 .PP
 100 .L mimelist
 101 lists the mime file contents on the
 102 .IR sfio (3)
 103 stream
 104 .IR sp .
 105 This is used for debugging mime entries.
 106 .PP
 107 .L mimetype
 108 returns the type string for
 109 .IR path .
 110 .L mimetype
 111 always returns a non-null string.
 112 If errors are encounterd on
 113 .I path
 114 then the return value will be
 115 .LR "error" .
 116 .SH "SEE ALSO"
 117 file(1), mime(4)