diff options
Diffstat (limited to 'lib/filenames.h')
-rw-r--r-- | lib/filenames.h | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/lib/filenames.h b/lib/filenames.h new file mode 100644 index 00000000..7e46b964 --- /dev/null +++ b/lib/filenames.h @@ -0,0 +1,54 @@ +/* + * filenames.h: Interface to composing and dissecting man page file names + * + * Copyright (C) 2001-2022 Colin Watson. + * + * This file is part of man-db. + * + * man-db is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * man-db is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with man-db; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef MAN_FILENAMES_H +#define MAN_FILENAMES_H + +#include <stdbool.h> + +#include "timespec.h" + +struct mandata { + char *addr; /* ptr to memory containing the fields */ + + char *name; /* Name of page, if != key */ + + /* The following are all const because they should be pointers to + * parts of strings allocated elsewhere (often the addr field above) + * and should not be written through or freed themselves. + */ + const char *ext; /* Filename ext w/o comp ext */ + const char *sec; /* Section name/number */ + char id; /* id for this entry */ + const char *pointer; /* id related file pointer */ + const char *comp; /* Compression extension */ + const char *filter; /* filters needed for the page */ + const char *whatis; /* whatis description for page */ + struct timespec mtime; /* mod time for file */ +}; + +extern char *make_filename (const char *path, const char *name, + struct mandata *in, const char *type); +extern char *filename_info (const char *file, struct mandata *info, + const char *req_name, bool warn_if_bogus); + +#endif /* MAN_FILENAMES_H */ |