dc_args::helpmsg Interface Reference

Public Member Functions
subroutine	dcargshelpmsg0 (arg, category, msg)

Detailed Description

Definition at line 350 of file dc_args.f90.

Member Function/Subroutine Documentation

dcargshelpmsg0()

subroutine dc_args::helpmsg::dcargshelpmsg0	(	type(args), intent(inout)	arg,
		character(*), intent(in)	category,
		character(*), intent(in)	msg
	)

Add help message

Adds a message to be displayed when using subroutine DCArgsHelp. Messages with category set to "Title", "Overview", or "Usage" are displayed above "Options", while others are displayed below. Give the message to msg.

Example

program dc_args_sample3
  use dc_types
  use dc_string, only: stoa
  use dc_args
  implicit none
  type(ARGS) :: arg
  logical :: OPT_namelist
  character(STRING) :: VAL_namelist
  character(STRING), pointer :: argv(:) => null()
  integer :: i
 
  call dcargsopen( arg = arg )
  call dcargshelpmsg( arg = arg, category = 'Title', &
    & msg = 'dcargs :: Test program of dc_args' )
  call dcargshelpmsg( arg = arg, category = 'Usage', &
    & msg = 'dcargs [Options] arg1, arg2, ...')
  call dcargsoption( arg = arg, options = stoa('-N', '--namelist'), &
    & flag = opt_namelist, value = val_namelist, help = "Namelist filename")
  call dcargshelpmsg( arg = arg, category = 'DESCRIPTION', &
    & msg = '(1) Define type "HASH". (2) Open the variable. ...')
  call dcargshelpmsg( arg = arg, category = 'Copyright', &
    & msg = 'Copyright (C) GFD Dennou Club, 2008. All rights reserved.')
  call dcargsdebug( arg = arg )
  call dcargshelp( arg = arg )
  call dcargsstrict( arg = arg )
  call dcargsget( arg = arg, argv = argv )
  write(*,*) '--namelist=', trim( val_namelist )
  do i = 1, size(argv)
    write(*,*) argv(i)
  end do
  deallocate( argv )
  call dcargsclose( arg = arg )
end program dc_args_sample3

By specifying any of '-h', '-H', '–help' options in command line arguments, the message given by HelpMsg and the list of options are displayed to standard output.

Parameters

[in,out]	arg	ARGS derived type variable
[in]	category	Category name ("Title", "Overview", "Usage", etc.)
[in]	msg	Help message to add

Definition at line 939 of file dc_args.f90.

    use dc_hash, only: dchashput
    use dc_string, only: uchar
    use dc_message, only: messagenotify
    implicit none
    type(ARGS), intent(inout) :: arg
    character(*), intent(in) :: category
    character(*), intent(in) :: msg
    character(len = *), parameter  :: subname = 'DCArgsHelpMsg'
  continue
    if (.not. arg % initialized) then
      call messagenotify('W', subname, 'Call Open before Help in dc_args.')
      call dcargsopen(arg)
    end if
    call dchashput(arg % helpmsg, key=uchar(category), value=msg)

---

The documentation for this interface was generated from the following file:

• dc_utils/dc_args.f90