Skip to content
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

Fix docs build #817

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docsrc/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
{% extends "!layout.html" %}
{% set css_files = css_files + [ '_static/cyrus.css' ] %}


{% block header %}
Expand Down
2 changes: 1 addition & 1 deletion docsrc/exts/themes/cyrus/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

{# RTD hosts this file, so just load on non RTD builds #}
{% if not READTHEDOCS %}
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
<link rel="stylesheet" href="{{ pathto('_static/cyrus.css', 1) }}" type="text/css" />
{% endif %}

{% for cssfile in css_files %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@ Synopsis
Description
===========

.. c:function:: int sasl_auxprop_add_plugin(const char *plugname,
sasl_auxprop_plug_init_t *cplugfunc);
.. c:function:: int sasl_auxprop_add_plugin(const char *plugname, sasl_auxprop_plug_init_t *cplugfunc);

**sasl_auxprop_add_plugin** adds an auxiliary property plugin to the
current list of auxiliary property plugins in the SASL library.
Expand Down
10 changes: 1 addition & 9 deletions docsrc/sasl/reference/manpages/library/sasl_canon_user_t.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,7 @@ Synopsis
Description
===========

.. c:function:: int sasl_canon_user_t(sasl_conn_t *conn,
void *context,
const char *user,
unsigned ulen,
unsigned flags,
const char *user_realm,
char *out_user,
unsigned out_umax,
unsigned *out_ulen)
.. c:function:: int sasl_canon_user_t(sasl_conn_t *conn, void *context, const char *user, unsigned ulen, unsigned flags, const char *user_realm, char *out_user, unsigned out_umax, unsigned *out_ulen)

**sasl_canon_user_t** is the callback for an application-supplied user canonicalization function. This function is
subject to the requirements that all user canonicalization
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@ Synopsis
Description
===========

.. c:function:: int sasl_canonuser_add_plugin(const char *plugname,
sasl_canonuser_plug_init_t *cplugfunc);
.. c:function:: int sasl_canonuser_add_plugin(const char *plugname, sasl_canonuser_plug_init_t *cplugfunc);

**sasl_canonuser_add_plugin** adds a user canonicalization plugin to the
current list of user canonicalization plugins in the SASL library.
Expand Down
8 changes: 1 addition & 7 deletions docsrc/sasl/reference/manpages/library/sasl_chalprompt_t.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,7 @@ Synopsis
Description
===========

.. c:function:: int sasl_chalprompt_t(void *context,
int id,
const char *challenge,
const char *prompt,
const char *defresult,
const char **result,
unsigned *len)
.. c:function:: int sasl_chalprompt_t(void *context, int id, const char *challenge, const char *prompt, const char *defresult, const char **result, unsigned *len)

**sasl_chalprompt_t** is used to prompt for input in response to a server challenge.

Expand Down
6 changes: 1 addition & 5 deletions docsrc/sasl/reference/manpages/library/sasl_checkapop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,7 @@ Synopsis
Description
===========

.. c:function:: int sasl_checkapop(sasl_conn_t *conn,
const char *challenge,
unsigned challen,
const char *response,
unsigned resplen)
.. c:function:: int sasl_checkapop(sasl_conn_t *conn, const char *challenge, unsigned challen, const char *response, unsigned resplen)

**sasl_checkapop** will check an APOP challenge/response.
APOP is an optional POP3 (:rfc:`1939`) authentication command
Expand Down
6 changes: 1 addition & 5 deletions docsrc/sasl/reference/manpages/library/sasl_checkpass.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,7 @@ Synopsis
Description
===========

.. c:function:: int sasl_checkpass(sasl_conn_t *conn,
const char *user,
unsigned userlen,
const char *pass,
unsigned passlen)
.. c:function:: int sasl_checkpass(sasl_conn_t *conn, const char *user, unsigned userlen, const char *pass, unsigned passlen)

**sasl_checkpass** will check a plaintext password. This is
needed for protocols that had a login method before SASL
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@ Synopsis
Description
===========

.. c:function:: int sasl_client_add_plugin(const char *plugname,
sasl_client_plug_init_t *cplugfunc);
.. c:function:: int sasl_client_add_plugin(const char *plugname, sasl_client_plug_init_t *cplugfunc);

**sasl_client_add_plugin** adds a client plugin to the
current in-memory list of client plugins in the SASL library.
Expand Down
8 changes: 1 addition & 7 deletions docsrc/sasl/reference/manpages/library/sasl_client_new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,7 @@ Synopsis
Description
===========

.. c:function:: int sasl_client_new(const char *service,
const char *serverFQDN,
const char *iplocalport,
const char *ipremoteport,
const sasl_callback_t *prompt_supp,
unsigned flags,
sasl_conn_t ** pconn);
.. c:function:: int sasl_client_new(const char *service, const char *serverFQDN, const char *iplocalport, const char *ipremoteport, const sasl_callback_t *prompt_supp, unsigned flags, sasl_conn_t ** pconn);

**sasl_client_new()** creates a new SASL context. This context will be
used for all SASL calls for one connection. It handles both
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,7 @@ Synopsis
Description
===========

.. c:function:: int sasl_client_plug_init_t(const sasl_utils_t *utils,
int max_version,
int *out_version,
sasl_client_plug_t **pluglist,
int *plugcount);
.. c:function:: int sasl_client_plug_init_t(const sasl_utils_t *utils, int max_version, int *out_version, sasl_client_plug_t **pluglist, int *plugcount);

The **sasl_client_plug_init_t** callback function is the client
plugin entry point.
Expand Down
7 changes: 1 addition & 6 deletions docsrc/sasl/reference/manpages/library/sasl_client_start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,7 @@ Synopsis
Description
===========

.. c:function:: int sasl_client_start(sasl_conn_t * conn,
const char * mechlist,
sasl_interact_t ** prompt_need,
const char ** clientout,
unsigned * clientoutlen,
const char ** mech);
.. c:function:: int sasl_client_start(sasl_conn_t * conn, const char * mechlist, sasl_interact_t ** prompt_need, const char ** clientout, unsigned * clientoutlen, const char ** mech);

**sasl_client_start()** selects a mechanism for authentication and starts the
authentication session. The mechlist is the list of mechanisms the client
Expand Down
7 changes: 1 addition & 6 deletions docsrc/sasl/reference/manpages/library/sasl_client_step.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,7 @@ Synopsis
Description
===========

.. c:function:: int sasl_client_step(sasl_conn_t *conn,
const char *serverin,
unsigned serverinlen,
sasl_interact_t ** prompt_need,
const char ** clientout,
unsigned * clientoutlen);
.. c:function:: int sasl_client_step(sasl_conn_t *conn, const char *serverin, unsigned serverinlen, sasl_interact_t ** prompt_need, const char ** clientout, unsigned * clientoutlen);

**sasl_client_step()** performs a step in the authentication negotiation. It
returns :c:macro:`SASL_OK` if the whole negotiation is successful and
Expand Down
6 changes: 1 addition & 5 deletions docsrc/sasl/reference/manpages/library/sasl_decode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,7 @@ Synopsis
Description
===========

.. c:function:: int sasl_decode(sasl_conn_t *conn,
const char * input,
unsigned inputlen,
const char ** output,
unsigned * outputlen);
.. c:function:: int sasl_decode(sasl_conn_t *conn, const char * input, unsigned inputlen, const char ** output, unsigned * outputlen);


**sasl_decode** decodes data received. After successful authentication
Expand Down
6 changes: 1 addition & 5 deletions docsrc/sasl/reference/manpages/library/sasl_decode64.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,7 @@ Synopsis
Description
===========

.. c:function:: int sasl_decode64(const char * input,
unsigned inputlen,
const char ** output,
unasigned outmax,
unsigned * outputlen);
.. c:function:: int sasl_decode64(const char * input, unsigned inputlen, const char ** output, unsigned outmax, unsigned * outputlen);


**sasl_decode64** decodes a base64 encoded buffer.
Expand Down
6 changes: 1 addition & 5 deletions docsrc/sasl/reference/manpages/library/sasl_dispose.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,7 @@ Synopsis
Description
===========

.. c:function:: int sasl_encode(sasl_conn_t *conn,
const char * input,
unsigned inputlen,
const char ** output,
unsigned * outputlen);
.. c:function:: int sasl_dispose(sasl_conn_t *conn)

**sasl_dispose** is called when a SASL connection object is no longer needed.

Expand Down
25 changes: 1 addition & 24 deletions docsrc/sasl/reference/manpages/library/sasl_encode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,6 @@ Synopsis
const char ** output,
unsigned * outputlen);

int sasl_encodev(sasl_conn_t *conn,
const struct iovec * invec,
unsigned numiov,
const char ** output,
unsigned * outputlen);


Description
===========
Expand All @@ -39,24 +33,7 @@ output is identical to the input.
**sasl_encodev** does the same, but for a `struct iovec` instead
of a character buffer.

.. c:function:: int sasl_encode(sasl_conn_t *conn,
const char * input,
unsigned inputlen,
const char ** output,
unsigned * outputlen);

:param conn: is the SASL connection context

:param output: contains the decoded data and is allocated/freed by
the library.

:param outputlen: length of `output`.

.. c:function:: int sasl_encodev(sasl_conn_t *conn,
const struct iovec * invec,
unsigned numiov,
const char ** output,
unsigned * outputlen);
.. c:function:: int sasl_encode(sasl_conn_t *conn, const char * input, unsigned inputlen, const char ** output, unsigned * outputlen);

:param conn: is the SASL connection context

Expand Down
6 changes: 1 addition & 5 deletions docsrc/sasl/reference/manpages/library/sasl_encode64.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,7 @@ string. This routine is useful for SASL profiles that use base64, such as the
IMAP (IMAP4) and POP (POP_AUTH) profiles. The output is null‐terminated. If
outlen is non‐NULL, the length is placed in the outlen.

.. c:function:: int sasl_encode64(const char * input,
unsigned inputlen,
const char ** output,
unsigned outmax,
unsigned * outputlen);
.. c:function:: int sasl_encode64(const char * input, unsigned inputlen, const char ** output, unsigned outmax, unsigned * outputlen);

:param input: input data.

Expand Down
31 changes: 4 additions & 27 deletions docsrc/sasl/reference/manpages/library/sasl_encodev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,6 @@ Synopsis

#include <sasl/sasl.h>

int sasl_encode(sasl_conn_t *conn,
const char * input,
unsigned inputlen,
const char ** output,
unsigned * outputlen);

int sasl_encodev(sasl_conn_t *conn,
const struct iovec * invec,
unsigned numiov,
Expand All @@ -30,33 +24,16 @@ Synopsis
Description
===========

**sasl_encode** encodes data to be sent to be sent to a remote host who we’ve
**sasl_encodev** encodes data to be sent to be sent to a remote host who we’ve
had a successful authentication session with. If there is a negotiated
security the data in signed/encrypted and the output should be sent
without modification to the remote host. If there is no security layer the
output is identical to the input.

**sasl_encodev** does the same, but for a `struct iovec` instead
of a character buffer.

.. c:function:: int sasl_encode(sasl_conn_t *conn,
const char * input,
unsigned inputlen,
const char ** output,
unsigned * outputlen);

:param conn: is the SASL connection context

:param output: contains the decoded data and is allocated/freed by
the library.

:param outputlen: length of `output`.
**sasl_encode** does the same, but for a character buffer instead
of a `struct iovec`.

.. c:function:: int sasl_encodev(sasl_conn_t *conn,
const struct iovec * invec,
unsigned numiov,
const char ** output,
unsigned * outputlen);
.. c:function:: int sasl_encodev(sasl_conn_t *conn, const struct iovec * invec, unsigned numiov, const char ** output, unsigned * outputlen);

:param conn: is the SASL connection context

Expand Down
4 changes: 1 addition & 3 deletions docsrc/sasl/reference/manpages/library/sasl_errstring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,7 @@ Synopsis
Description
===========

.. c:function:: const char * sasl_errstring(int saslerr,
const char * langlist,
const char ** outlang);
.. c:function:: const char * sasl_errstring(int saslerr, const char * langlist, const char ** outlang);

**sasl_errstring** is called to convert a SASL return code (an
integer) into a human readable string. At this time the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,7 @@ Synopsis

Description
===========
.. c:function:: int sasl_getcallback_t(sasl_conn_t *conn,
unsigned long callbacknum,
int (**proc)( ),
void **pcontext);
.. c:function:: int sasl_getcallback_t(sasl_conn_t *conn, unsigned long callbacknum, int (**proc)( ), void **pcontext);

The **sasl_getcallback_t()** function is a callback to lookup
a sasl_callback_t for a connection.
Expand Down
6 changes: 1 addition & 5 deletions docsrc/sasl/reference/manpages/library/sasl_getopt_t.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,7 @@ Synopsis
Description
===========

.. c:function:: int sasl_getopt_t(void *context,
const char *plugin_name,
const char *option,
const char ** result,
unsigned * len);
.. c:function:: int sasl_getopt_t(void *context, const char *plugin_name, const char *option, const char ** result, unsigned * len);

**sasl_getopt_t** is used to retrieve an option, often mechanism specific,
from the application. An example of this is
Expand Down
4 changes: 1 addition & 3 deletions docsrc/sasl/reference/manpages/library/sasl_getprop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,7 @@ Synopsis
Description
===========

.. c:function:: int sasl_getprop(sasl_conn_t *conn,
int propnum,
const void ** pvalue);
.. c:function:: int sasl_getprop(sasl_conn_t *conn, int propnum, const void ** pvalue);

**sasl_getprop** gets the value of a SASL property. For example after
successful authentication a server may wish to know the authorization
Expand Down
5 changes: 1 addition & 4 deletions docsrc/sasl/reference/manpages/library/sasl_getrealm_t.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,7 @@ Synopsis
Description
===========

.. c:function:: int sasl_getrealm_t(void *context,
int id,
const char **availrealms,
const char **result)
.. c:function:: int sasl_getrealm_t(void *context, int id, const char **availrealms, const char **result)

**sasl_getrealm_t()** is used when there is an interaction with
SASL_CB_GETREALM as the type.
Expand Down
5 changes: 1 addition & 4 deletions docsrc/sasl/reference/manpages/library/sasl_getsecret_t.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,7 @@ Synopsis
Description
===========

.. c:function:: int sasl_getsecret_t(sasl_conn_t *conn,
void *context,
int id,
sasl_secret_t ** psecret);
.. c:function:: int sasl_getsecret_t(sasl_conn_t *conn, void *context, int id, sasl_secret_t ** psecret);


**sasl_getsecret_t()** is used to retrieve the secret from the
Expand Down
5 changes: 1 addition & 4 deletions docsrc/sasl/reference/manpages/library/sasl_getsimple_t.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,7 @@ Synopsis
Description
===========

.. c:function:: int sasl_getsimple_t(void *context,
int id,
const char ** result,
unsigned * len);
.. c:function:: int sasl_getsimple_t(void *context, int id, const char ** result, unsigned * len);

**sasl_getsimple_t** is used to retrieve simple things from
the application. In practice this is authentication name,
Expand Down
9 changes: 1 addition & 8 deletions docsrc/sasl/reference/manpages/library/sasl_listmech.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,7 @@ Synopsis
Description
===========

.. c:function:: int sasl_listmech(sasl_conn_t *conn,
const char *user,
const char *prefix,
const char *sep,
const char *suffix,
const char **result,
unsigned *plen,
int *pcount);
.. c:function:: int sasl_listmech(sasl_conn_t *conn, const char *user, const char *prefix, const char *sep, const char *suffix, const char **result, unsigned *plen, int *pcount);

**sasl_listmech** returns a string listing the SASL names of
all the mechanisms available to the specified user. This
Expand Down
Loading