-
Notifications
You must be signed in to change notification settings - Fork 66
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
man pages #21
Comments
The web subdir has a lot of the necessary content for the command line program (man 1) and C api (man 3). It would also be nice to write dbf and shape format man pages (man 7) |
Is ronn dead? rtomayko/ronn#111 → https://github.com/apjanke/ronn-ng ronn-ng is what you get when you However, I have been having a few troubles with ronn. Trying this: pandoc DBFOpen.md -s -t man | /usr/bin/man -l - It looks like % BDFOpen(3)
# NAME
DBFOpen - connect an existing xBase format table file
# SYNOPSIS
\#include \<stdio.h\>
DBFHandle *DBFOpen*(const char *pszDBFFile, const char \*pszAccess\);
# DESCRIPTION
The DBFOpen() function should be used to establish access to an existing xBase
format table file. The returned DBFHandle is passed to other access functions,
and DBFClose() should be invoked to recover resources, and flush changes to disk
when complete. The DBFCreate() function should called to create new xBase
files. As a convenience, DBFOpen() can be called with the name of a .shp or
.shx file, and it will figure out the name of the related .dbf file.
# RETURN VALUE
Foo
# EXAMPLES
Bar
# SEE ALSO
Baz |
A first draft of a pandoc driven man page. % BDFOpen(3)
# NAME
**DBFOpen** - connect an existing xBase format table file
# SYNOPSIS
\#include \<stdio.h\>
DBFHandle **DBFOpend**(const char \**pszDBFFile*, const char \**pszAccess*\);
# DESCRIPTION
The **DBFOpen()** function should be used to establish access to an existing
xBase format table file. The returned DBFHandle is passed to other access
functions, and **DBFClose()** should be invoked to recover resources, and flush
changes to disk when complete. The **DBFCreate()** function should called to create
new xBase files. As a convenience, **DBFOpen()** can be called with the name of a
.shp or .shx file, and it will figure out the name of the related .dbf file.
Parameters:
- *pszDBFFile*:
The name of the xBase (.dbf) file to access.
- *pszAccess*:
The fopen() style access string. At this time only
"rb" (read-only binary) and "rb+" (read/write binary)
should be used.
# RETURN VALUE
Returns a *DBFHandle* that is a pointer that must be closed with **DBFClose()**.
Returns a *NULL* pointer on error.
# EXAMPLES
Opening and closing a xBase dbf file:
\`\`\`c
#include <shapefil.h>
DBFHandle handle = DBFOpen(filepath.c_str(), "rb");
if (handle == NULL) {
exit(EXIT_FAILURE);
}
// Operate on handle.
DBFClose(handle);
\`\`\`
# SEE ALSO
dbfdump(1) dbfinfo(1) DBFClose(3) DBFCreate(3) dbf(7) Built with
|
Following up on #17, this repo doesn't have man pages. I'm contacting the debian folks (Bas Couwenberg and Francesco Paolo Lovergine) to see about using the ones they package as a starting point.
http://deb.debian.org/debian/pool/main/s/shapelib/shapelib_1.5.0-2.debian.tar.xz
From rules:
It has these markdown sources for man pages:
The text was updated successfully, but these errors were encountered: