usage.h 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)
	Generate USAGE section content.
void	manpage_content_free_usage (char *content)
	Free generated usage content.

Detailed Description

USAGE section generator for man pages.

Generates the USAGE section from usage descriptors showing different ways to invoke the program.

Definition in file usage.h.

Function Documentation

manpage_content_free_usage()

void manpage_content_free_usage

(

char *

content

)

Free generated usage content.

Parameters

[in]

content

Content to free (can be NULL)

Definition at line 61 of file usage.c.

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

References SAFE_FREE.

manpage_content_generate_usage()

char * manpage_content_generate_usage

(

const options_config_t *

config

)

Generate USAGE section content.

Creates USAGE section from usage descriptors with proper groff tagged paragraph formatting.

Parameters

[in]

config

Options configuration with usage descriptors

Returns

Newly allocated content string (caller must free)

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 buffer_capacity(), escape_groff_special(), log_debug, options_config_t::num_usage_lines, SAFE_MALLOC, SAFE_REALLOC, safe_snprintf(), usage(), and options_config_t::usage_lines.