devs/cproof
1
2
Fork 1
Code Issues 43 Pull Requests 9 Actions Packages Projects 1 Releases Wiki Activity

Create cmd to generate man pages for prof commands

Browse Source 
`profanity mangen` will create for each command (`/account`, `/roster`)
an own manpage (`profanity-account.1`, `profanity-roster.1`)

See https://github.com/profanity-im/profanity/issues/1444

Needs some polishing formatting wise.
This commit is contained in:
Michael Vetter
2020-12-04 17:29:31 +01:00
parent 35aecd425f
commit 5e99a791e6
4 changed files with 80 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
src/command/cmd_defs.c
View File

@@ -2833,3 +2833,70 @@ command_docgen(void)
printf("\nProcessed %d commands.\n\n", g_list_length(cmds));
g_list_free(cmds);
}
void
command_mangen(void)
{
GList* cmds = NULL;
for (unsigned int i = 0; i < ARRAY_SIZE(command_defs); i++) {
Command* pcmd = command_defs + i;
cmds = g_list_insert_sorted(cmds, pcmd, (GCompareFunc)_cmp_command);
}
mkdir_recursive("docs");
GList* curr = cmds;
while (curr) {
Command* pcmd = curr->data;
char* filename = NULL;
if (asprintf(&filename, "docs/profanity-%s.1", &pcmd->cmd[1]) == -1) {
// TODO: error
return;
}
FILE* manpage = fopen(filename, "w");
free(filename);
fputs(".TH man 1 \"2020-07-01\" \""PACKAGE_VERSION"\" \"Profanity XMPP client\"\n", manpage);
fputs(".SH NAME\n", manpage);
fprintf(manpage, "%s\n", pcmd->cmd);
fputs("\n.SH DESCRIPTION\n", manpage);
fprintf(manpage, "%s\n", pcmd->help.desc);
fputs("\n.SH SYNOPSIS\n", manpage);
int i = 0;
while (pcmd->help.synopsis[i]) {
fprintf(manpage, "%s\n", pcmd->help.synopsis[i]);
fputs("\n.BR\n", manpage);
i++;
}
if (pcmd->help.args[0][0] != NULL) {
fputs("\n.SH ARGUMENTS\n", manpage);
for (i = 0; pcmd->help.args[i][0] != NULL; i++) {
fprintf(manpage, "%s\n", pcmd->help.args[i][0]);
fprintf(manpage, "%s\n", pcmd->help.args[i][1]);
fputs("\n.BR\n", manpage);
}
}
if (pcmd->help.examples[0] != NULL) {
fputs("\n.SH EXAMPLES\n", manpage);
int i = 0;
while (pcmd->help.examples[i]) {
fprintf(manpage, "%s\n", pcmd->help.examples[i]);
fputs("\n.BR\n", manpage);
i++;
}
}
curr = g_list_next(curr);
fclose(manpage);
}
printf("\nProcessed %d commands.\n\n", g_list_length(cmds));
g_list_free(cmds);
}

1
src/command/cmd_defs.h
View File

@@ -50,6 +50,7 @@ GList* cmd_get_ordered(const char* const tag);
gboolean cmd_valid_tag(const char* const str);
void command_docgen(void);
void command_mangen(void);
GList* cmd_search_index_all(char* term);
GList* cmd_search_index_any(char* term);