flap_save_usage_to_markdown Program

Uses

  • program~~flap_save_usage_to_markdown~~UsesGraph program~flap_save_usage_to_markdown flap_save_usage_to_markdown module~flap flap program~flap_save_usage_to_markdown->module~flap penf penf program~flap_save_usage_to_markdown->penf module~flap_command_line_argument_t flap_command_line_argument_t module~flap->module~flap_command_line_argument_t module~flap_command_line_arguments_group_t flap_command_line_arguments_group_t module~flap->module~flap_command_line_arguments_group_t module~flap_command_line_interface_t flap_command_line_interface_t module~flap->module~flap_command_line_interface_t module~flap_command_line_argument_t->penf module~face face module~flap_command_line_argument_t->module~face module~flap_object_t flap_object_t module~flap_command_line_argument_t->module~flap_object_t module~flap_utils_m flap_utils_m module~flap_command_line_argument_t->module~flap_utils_m module~flap_command_line_arguments_group_t->penf module~flap_command_line_arguments_group_t->module~flap_command_line_argument_t module~flap_command_line_arguments_group_t->module~face module~flap_command_line_arguments_group_t->module~flap_object_t module~flap_command_line_interface_t->penf module~flap_command_line_interface_t->module~flap_command_line_argument_t module~flap_command_line_interface_t->module~flap_command_line_arguments_group_t module~flap_command_line_interface_t->module~face module~flap_command_line_interface_t->module~flap_object_t module~flap_command_line_interface_t->module~flap_utils_m iso_fortran_env iso_fortran_env module~face->iso_fortran_env module~flap_object_t->penf module~flap_object_t->iso_fortran_env module~flap_utils_m->penf

Test save_usage_to_markdown method.


Calls

program~~flap_save_usage_to_markdown~~CallsGraph program~flap_save_usage_to_markdown flap_save_usage_to_markdown none~get~2 flap_command_line_interface_t::command_line_interface%get program~flap_save_usage_to_markdown->none~get~2 proc~add~2 flap_command_line_interface_t::command_line_interface%add program~flap_save_usage_to_markdown->proc~add~2 proc~init flap_command_line_interface_t::command_line_interface%init program~flap_save_usage_to_markdown->proc~init proc~save_usage_to_markdown flap_command_line_interface_t::command_line_interface%save_usage_to_markdown program~flap_save_usage_to_markdown->proc~save_usage_to_markdown proc~get_cla_list~2 flap_command_line_interface_t::command_line_interface%get_cla_list none~get~2->proc~get_cla_list~2 proc~get_cla~2 flap_command_line_interface_t::command_line_interface%get_cla none~get~2->proc~get_cla~2 proc~add flap_command_line_arguments_group_t::command_line_arguments_group%add proc~add~2->proc~add proc~add_group flap_command_line_interface_t::command_line_interface%add_group proc~add~2->proc~add_group proc~assign_object flap_object_t::object%assign_object proc~add~2->proc~assign_object proc~check~2 flap_command_line_argument_t::command_line_argument%check proc~add~2->proc~check~2 proc~is_defined_group flap_command_line_interface_t::command_line_interface%is_defined_group proc~add~2->proc~is_defined_group proc~upper_case flap_utils_m::upper_case proc~add~2->proc~upper_case proc~init->proc~assign_object proc~set_examples flap_object_t::object%set_examples proc~init->proc~set_examples proc~signature~3 flap_command_line_interface_t::command_line_interface%signature proc~save_usage_to_markdown->proc~signature~3 proc~usage~3 flap_command_line_interface_t::command_line_interface%usage proc~save_usage_to_markdown->proc~usage~3 strz strz proc~save_usage_to_markdown->strz proc~check flap_command_line_arguments_group_t::command_line_arguments_group%check proc~add->proc~check proc~add_group->proc~assign_object proc~add_group->proc~is_defined_group proc~add_group->proc~set_examples proc~check_action_consistency flap_command_line_argument_t::command_line_argument%check_action_consistency proc~check~2->proc~check_action_consistency proc~check_envvar_consistency flap_command_line_argument_t::command_line_argument%check_envvar_consistency proc~check~2->proc~check_envvar_consistency proc~check_m_exclude_consistency flap_command_line_argument_t::command_line_argument%check_m_exclude_consistency proc~check~2->proc~check_m_exclude_consistency proc~check_named_consistency flap_command_line_argument_t::command_line_argument%check_named_consistency proc~check~2->proc~check_named_consistency proc~check_optional_consistency flap_command_line_argument_t::command_line_argument%check_optional_consistency proc~check~2->proc~check_optional_consistency proc~check_positional_consistency flap_command_line_argument_t::command_line_argument%check_positional_consistency proc~check~2->proc~check_positional_consistency proc~get_cla_list~2->proc~is_defined_group none~get flap_command_line_argument_t::command_line_argument%get proc~get_cla_list~2->none~get proc~errored~3 flap_command_line_interface_t::command_line_interface%errored proc~get_cla_list~2->proc~errored~3 proc~parse~2 flap_command_line_interface_t::command_line_interface%parse proc~get_cla_list~2->proc~parse~2 proc~get_cla~2->proc~is_defined_group proc~get_cla~2->none~get proc~get_cla~2->proc~errored~3 proc~get_cla~2->proc~parse~2 proc~signature flap_command_line_arguments_group_t::command_line_arguments_group%signature proc~signature~3->proc~signature proc~usage~3->proc~signature~3 proc~usage flap_command_line_arguments_group_t::command_line_arguments_group%usage proc~usage~3->proc~usage proc~get_cla flap_command_line_argument_t::command_line_argument%get_cla none~get->proc~get_cla proc~get_cla_list flap_command_line_argument_t::command_line_argument%get_cla_list none~get->proc~get_cla_list proc~errored flap_command_line_arguments_group_t::command_line_arguments_group%errored proc~check->proc~errored proc~is_defined flap_command_line_arguments_group_t::command_line_arguments_group%is_defined proc~check->proc~is_defined proc~errored~2 flap_command_line_argument_t::command_line_argument%errored proc~check_action_consistency->proc~errored~2 proc~check_envvar_consistency->proc~errored~2 proc~check_m_exclude_consistency->proc~errored~2 proc~check_named_consistency->proc~errored~2 proc~check_optional_consistency->proc~errored~2 proc~check_positional_consistency->proc~errored~2 interface~colorize face::colorize proc~errored~3->interface~colorize proc~print_error_message flap_object_t::object%print_error_message proc~errored~3->proc~print_error_message proc~parse~2->proc~add~2 proc~parse~2->proc~save_usage_to_markdown proc~parse~2->proc~usage~3 none~get_args flap_command_line_interface_t::command_line_interface%get_args proc~parse~2->none~get_args proc~check_m_exclusive~2 flap_command_line_interface_t::command_line_interface%check_m_exclusive proc~parse~2->proc~check_m_exclusive~2 proc~check~3 flap_command_line_interface_t::command_line_interface%check proc~parse~2->proc~check~3 proc~is_defined~2 flap_command_line_interface_t::command_line_interface%is_defined proc~parse~2->proc~is_defined~2 proc~is_required_passed flap_command_line_arguments_group_t::command_line_arguments_group%is_required_passed proc~parse~2->proc~is_required_passed proc~parse flap_command_line_arguments_group_t::command_line_arguments_group%parse proc~parse~2->proc~parse proc~print_version flap_object_t::object%print_version proc~parse~2->proc~print_version proc~sanitize_defaults flap_command_line_arguments_group_t::command_line_arguments_group%sanitize_defaults proc~parse~2->proc~sanitize_defaults proc~signature~2 flap_command_line_argument_t::command_line_argument%signature proc~signature->proc~signature~2 proc~usage->proc~signature proc~usage~2 flap_command_line_argument_t::command_line_argument%usage proc~usage->proc~usage~2 proc~colorize_default face::colorize_default interface~colorize->proc~colorize_default proc~get_args_from_invocation flap_command_line_interface_t::command_line_interface%get_args_from_invocation none~get_args->proc~get_args_from_invocation proc~get_args_from_string flap_command_line_interface_t::command_line_interface%get_args_from_string none~get_args->proc~get_args_from_string proc~check_m_exclusive~2->proc~is_defined_group proc~raise_error_m_exclude flap_command_line_arguments_group_t::command_line_arguments_group%raise_error_m_exclude proc~check_m_exclusive~2->proc~raise_error_m_exclude proc~check~3->proc~is_defined_group proc~check~3->proc~check proc~errored->interface~colorize proc~errored->proc~print_error_message str str proc~errored->str proc~errored~2->interface~colorize proc~errored~2->proc~print_error_message proc~errored~2->str proc~get_cla->proc~errored~2 proc~check_choices flap_command_line_argument_t::command_line_argument%check_choices proc~get_cla->proc~check_choices proc~get_cla_from_buffer flap_command_line_argument_t::command_line_argument%get_cla_from_buffer proc~get_cla->proc~get_cla_from_buffer proc~is_required_passed~2 flap_command_line_argument_t::command_line_argument%is_required_passed proc~get_cla->proc~is_required_passed~2 proc~get_cla_list->proc~errored~2 proc~get_cla_list_from_buffer flap_command_line_argument_t::command_line_argument%get_cla_list_from_buffer proc~get_cla_list->proc~get_cla_list_from_buffer proc~get_cla_list->proc~is_required_passed~2 proc~tokenize flap_utils_m::tokenize proc~get_cla_list->proc~tokenize proc~is_defined~2->proc~is_defined_group proc~is_defined~2->proc~is_defined proc~is_required_passed->proc~usage proc~is_required_passed->proc~is_required_passed~2 proc~parse->proc~add proc~parse->proc~assign_object proc~parse->proc~is_defined proc~parse->proc~sanitize_defaults cton cton proc~parse->cton proc~check_m_exclusive flap_command_line_arguments_group_t::command_line_arguments_group%check_m_exclusive proc~parse->proc~check_m_exclusive proc~raise_error_duplicated_clas flap_command_line_argument_t::command_line_argument%raise_error_duplicated_clas proc~parse->proc~raise_error_duplicated_clas proc~raise_error_nargs_insufficient flap_command_line_argument_t::command_line_argument%raise_error_nargs_insufficient proc~parse->proc~raise_error_nargs_insufficient proc~raise_error_switch_unknown flap_command_line_argument_t::command_line_argument%raise_error_switch_unknown proc~parse->proc~raise_error_switch_unknown proc~raise_error_value_missing flap_command_line_argument_t::command_line_argument%raise_error_value_missing proc~parse->proc~raise_error_value_missing proc~sanitize_defaults~2 flap_command_line_argument_t::command_line_argument%sanitize_defaults proc~sanitize_defaults->proc~sanitize_defaults~2 proc~signature~2->cton proc~has_choices flap_command_line_argument_t::command_line_argument%has_choices proc~signature~2->proc~has_choices proc~signature~2->str proc~usage~2->interface~colorize proc~usage~2->cton proc~replace_all flap_utils_m::replace_all proc~usage~2->proc~replace_all proc~usage~2->str proc~check_choices->proc~errored~2 proc~check_choices->cton proc~check_choices->proc~tokenize proc~check_choices->str proc~is_passed flap_command_line_arguments_group_t::command_line_arguments_group%is_passed proc~check_m_exclusive->proc~is_passed proc~raise_error_m_exclude~2 flap_command_line_argument_t::command_line_argument%raise_error_m_exclude proc~check_m_exclusive->proc~raise_error_m_exclude~2 proc~color_index face::color_index proc~colorize_default->proc~color_index proc~style_index face::style_index proc~colorize_default->proc~style_index proc~upper face::upper proc~colorize_default->proc~upper proc~get_clasg_indexes flap_command_line_interface_t::command_line_interface%get_clasg_indexes proc~get_args_from_invocation->proc~get_clasg_indexes proc~get_args_from_string->proc~tokenize proc~get_args_from_string->proc~get_clasg_indexes proc~get_cla_from_buffer->proc~errored~2 proc~get_cla_from_buffer->cton proc~get_cla_list_from_buffer->proc~errored~2 proc~get_cla_list_from_buffer->cton proc~get_cla_list_from_buffer->proc~check_choices proc~get_cla_list_from_buffer->proc~tokenize proc~is_required_passed~2->proc~errored~2 proc~raise_error_duplicated_clas->proc~errored~2 proc~raise_error_m_exclude->proc~errored proc~raise_error_nargs_insufficient->proc~errored~2 proc~raise_error_switch_unknown->proc~errored~2 proc~raise_error_value_missing->proc~errored~2 proc~replace flap_utils_m::replace proc~replace_all->proc~replace proc~wstrip flap_utils_m::wstrip proc~replace_all->proc~wstrip proc~sanitize_defaults~2->proc~replace_all proc~unique flap_utils_m::unique proc~sanitize_defaults~2->proc~unique proc~sanitize_defaults~2->proc~wstrip proc~get_clasg_indexes->proc~is_defined_group proc~raise_error_m_exclude~2->proc~errored~2

Variables

Type Attributes Name Initial
type(command_line_interface) :: cli

Command Line Interface (CLI).
character(len=99) :: md

Markdown file name.
integer(kind=I4P) :: i

Integer input.
real(kind=R8P) :: r

Real input.

Source Code

program flap_save_usage_to_markdown
!< Test `save_usage_to_markdown` method.

use flap, only : command_line_interface
use penf

implicit none
type(command_line_interface) :: cli !< Command Line Interface (CLI).
character(99)                :: md  !< Markdown file name.
integer(I4P)                 :: i   !< Integer input.
real(R8P)                    :: r   !< Real input.

call cli%init(progname='flap_save_usage_to_markdown',                 &
              version='1.1.2',                                        &
              authors='Batman and Robin',                             &
              license='GPL v3',                                       &
              description = 'FLAP test save man page',                &
              examples=['flap_save_usage_to_markdown                       ', &
                        'flap_save_usage_to_markdown -m test.md -i 4       ', &
                        'flap_save_usage_to_markdown 3.2 -m test.md        ', &
                        'flap_save_usage_to_markdown -1.5 -m test.md -i 102'])
call cli%add(switch='--md',      switch_ab='-m', help='markdown file name', required=.false., act='store', def='test.md')
call cli%add(switch='--integer', switch_ab='-i', help='a integer',          required=.false., act='store', def='2'      )
call cli%add(positional=.true.,position=1,       help='a positional real',  required=.false.,              def='1.0'    )
call cli%get(switch='-m',    val=md)
call cli%save_usage_to_markdown(markdown_file=trim(md))
endprogram flap_save_usage_to_markdown