usage.c File Reference

USAGE section generator for man pages. More...

Go to the source code of this file.

Functions
char *	manpage_content_generate_usage (const options_config_t *config)
void	manpage_content_free_usage (char *content)

Detailed Description

USAGE section generator for man pages.

Definition in file usage.c.

Function Documentation

manpage_content_free_usage()

void manpage_content_free_usage

(

char *

content

)

Definition at line 61 of file usage.c.

                                               {
  if (content) {
    SAFE_FREE(content);
  }
}

manpage_content_generate_usage()

char * manpage_content_generate_usage

(

const options_config_t *

config

)

Definition at line 15 of file usage.c.

                                                                     {
  if (!config || config->num_usage_lines == 0) {
    char *buffer = SAFE_MALLOC(1, char *);
    buffer[0] = '\0';
    return buffer;
  }
 
  // Allocate growing buffer for usage section
  size_t buffer_capacity = 4096;
  char *buffer = SAFE_MALLOC(buffer_capacity, char *);
  size_t offset = 0;
 
  for (size_t i = 0; i < config->num_usage_lines; i++) {
    const usage_descriptor_t *usage = &config->usage_lines[i];
 
    // Ensure buffer is large enough
    if (offset + 512 >= buffer_capacity) {
      buffer_capacity *= 2;
      buffer = SAFE_REALLOC(buffer, buffer_capacity, char *);
    }
 
    offset += safe_snprintf(buffer + offset, buffer_capacity - offset, ".TP\n");
    offset += safe_snprintf(buffer + offset, buffer_capacity - offset, ".B ascii-chat");
    if (usage->mode) {
      offset += safe_snprintf(buffer + offset, buffer_capacity - offset, " %s", usage->mode);
    }
    if (usage->positional) {
      offset += safe_snprintf(buffer + offset, buffer_capacity - offset, " %s", usage->positional);
    }
    if (usage->show_options) {
      offset += safe_snprintf(buffer + offset, buffer_capacity - offset, " [options...]");
    }
    offset += safe_snprintf(buffer + offset, buffer_capacity - offset, "\n");
 
    if (usage->description) {
      offset +=
          safe_snprintf(buffer + offset, buffer_capacity - offset, "%s\n", escape_groff_special(usage->description));
    }
  }
 
  offset += safe_snprintf(buffer + offset, buffer_capacity - offset, "\n");
 
  log_debug("Generated USAGE section (%zu bytes)", offset);
  return buffer;
}

References escape_groff_special(), safe_snprintf(), and usage().