Logo Search packages:      
Sourcecode: codeblocks version File versions  Download package

man2html.h

Go to the documentation of this file.
/**
 * \file man2html.h
 *
 * \note Despite that this file is installed publically, it should not be included
 * \todo ### KDE4: make this file private
 *
 */

#ifndef MAN2HTML_H
#define MAN2HTML_H

/** call this with the buffer you have */
void scan_man_page(const char *man_page);

/**
 * Set the paths to KDE resources
 *
 * \param htmlPath Path to the KDE resources, encoded for HTML
 * \param cssPath Path to the KDE resources, encoded for CSS
 * \since 3.5
 *
 */
//extern void setResourcePath(const QByteArray& _htmlPath, const QByteArray& _cssPath);

/** implement this somewhere. It will be called
   with HTML contents
*/
extern void output_real(const char *insert);

/**
 * called for requested man pages. filename can be a
 * relative path! Return NULL on errors. The returned
 * char array is freed by man2html
 */
extern char *read_man_page(const char *filename);

/**
  * returns the man page provided in filename as an
  * HTML file
  */
extern const char *man2html(const char *filename);

/**
  * returns the man page provided in buffer as an
  * HTML file
  */
extern const char *man2html_buffer(const char *buffer);

#endif // MAN2HTML_H

Generated by  Doxygen 1.6.0   Back to index