discuss@mandoc.bsd.lv
 help / color / mirror / Atom feed
* Allowing "?" as a flag in mdoc
@ 2021-01-24 15:39 Aisha Tammy
  2021-01-24 15:49 ` Aisha Tammy
  2021-01-24 17:01 ` Raf Czlonka
  0 siblings, 2 replies; 6+ messages in thread
From: Aisha Tammy @ 2021-01-24 15:39 UTC (permalink / raw)
  To: discuss

[-- Attachment #1: Type: text/plain, Size: 462 bytes --]

Hi,
  I'm trying to create a manpage where the command takes a flag "?"
The command would (to display help):
  module -?

For this I created in module.1:

.Bl -tag -width Ds -compact
.It Fl h , ? , H , -help
Show the help message.
.El

But the output of this looks:

     -h,?, -H, --help
             Show the help message.

Without the - before ?

Can anyone tell how I can display a -? before the flag?

Thanks,
Aisha

[-- Attachment #2: Type: text/html, Size: 754 bytes --]

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: Allowing "?" as a flag in mdoc
  2021-01-24 15:39 Allowing "?" as a flag in mdoc Aisha Tammy
@ 2021-01-24 15:49 ` Aisha Tammy
  2021-01-24 17:01 ` Raf Czlonka
  1 sibling, 0 replies; 6+ messages in thread
From: Aisha Tammy @ 2021-01-24 15:49 UTC (permalink / raw)
  To: discuss

[-- Attachment #1: Type: text/plain, Size: 574 bytes --]

Full manpage attached, cuz i forgot last time.


On 1/24/21 10:39 AM, Aisha Tammy wrote:
> Hi,
>   I'm trying to create a manpage where the command takes a flag "?"
> The command would (to display help):
>   module -?
> 
> For this I created in module.1:
> 
> .Bl -tag -width Ds -compact
> .It Fl h , ? , H , -help
> Show the help message.
> .El
> 
> But the output of this looks:
> 
>      -h,?, -H, --help
>              Show the help message.
> 
> Without the - before ?
> 
> Can anyone tell how I can display a -? before the flag?
> 
> Thanks,
> Aisha

[-- Attachment #2: module.1 --]
[-- Type: text/plain, Size: 6887 bytes --]

.Dd $Mdocdate: December 6 2020 $
.Dt MODULE 1
.Os
.Sh NAME
.Nm module
.Nd lmod environment modules manager
.Sh SYNOPSIS
.Nm module
.Op options
.Cm sub-command
.Op args ...
.Sh DESCRIPTION
.Nm
from
.Sy Lmod
is a
.Xr lua 1
based program to manage the user environment under
Unix systems, specifically designed to easily handle
the
.Ev MODULEPATH
Hierarchical problem.
Environment Modules provide a convenient way to
dynamically change the users' environment through modulefiles.
This includes easily adding or removing directories to the
.Ev PATH , LD_LIBRARY_PATH
and other environment variables.
.Sh OPTIONS
The following
.Ar options
are available:
.Pp
.Bl -tag -width Ds -compact
.It Fl h , ? , H , -help
Show the help message.
.Pp
.It Fl -check_syntax , -checkSyntax
Only check the
.Nm
command syntax, do not load any modules.
.Pp
.It Fl -config
Report
.Sy Lmod
configuration.
.Pp
.It Fl -config_json
Report
.Sy Lmod
configuration in json format.
.Pp
.It Fl D
Write program tracing data to stderr.
.Pp
.It Fl d , -default
List default modules only when used with
.Cm avail .
.Pp
.It Fl -debug Ar dbglvl
.Sy VALUES :
1, 2, 3.
.Pp
Only write trace output with proper debug levels.
.Pp
.It Fl -dumpversion
Dump version in a machine readable way and quit.
.Pp
.It Fl -expert
Work in expert mode.
.Pp
.It Fl -force
Force removal of a sticky module or save an empty collection.
.Pp
.It Fl -gitversion
Dump git version in a machine readable way and quit.
.Pp
.It Fl -ignore_cache
Treat the cache file(s) as out-of-date.
.Pp
.It Fl -initial_load
Loading Lmod for first time in a user shell.
.Pp
.It Fl -latest
Load latest (ignore default).
.Pp
.It Fl -mt
Report Module Table State.
.Pp
.It Fl -no_redirect
Force output of
.Cm list ,
.Cm avail
and
.Cm spider
to stderr.
.Pp
.It Fl -novice
Turn off
.Fl -expert
and
.Fl -quiet
flags.
.Pp
.It Fl -nx , -no_extensions
.Pp
.It Fl -pin_versions Ar pinVersions
When doing a restore use the specified version, do not follow defaults.
.Pp
.It Fl q , -quiet
Do not print out warnings.
.Pp
.It Fl r , -regexp
Use regular expression match.
.Pp
.It Fl -raw
Print modulefile in raw output when used with show.
.Pp
.It Fl -redirect
Send the output of
.Cm list ,
.Cm avail
and
.Cm spider
to stdout (not stderr).
.Pp
.It Fl -regression_testing
Lmod regression testing.
.Pp
.It Fl -show_hidden
.Cm avail
and
.Cm spider
will report hidden modules.
.Pp
.It Fl -spider_timeout Ar timeout
A timeout for
.Cm spider .
.Pp
.It Fl s , -style Ar availStyle
.Sy DEFAULT :
system
Site controlled avail style.
.Pp
.It Fl T , -trace
.Pp
.It Fl t , -terse
Write out in machine readable format for
.Cm list ,
.Cm avail ,
.Cm spider
and
.Cm savelist .
.Pp
.It Fl -timer
Report run times.
.Pp
.It Fl v , -version
Print version info and quit.
.Pp
.It Fl -w , --width Ar twidth
Use
.Ar twidth
as max term width.
.El
.Sh SUB-COMMANDS
.Ss HELP
.Bl -tag -width Ds -compact
.It Cm help
Print the help message.
.Pp
.It Cm help Ar module Op moduleX moduleY ...
Print help messages from the given module(s).
.El
.Ss LOAD
.Bl -tag -width Ds -compact
.It Cm load , add Ar module Op moduleX moduleY ...
Load module(s)
.Pp
.It Cm try-load , try-add Ar module Op moduleX module Y ...
Load module(s), do not complain if not found
.Pp
.It Cm del , unload Ar module Op moduleX moduleY ...
Unload module(s), does not complain if not found
.Pp
.It Cm swap , sw , switch Ar m1 m2
.Cm unload
.Ar m1
and
.Cm load
.Ar m2
.Pp
.It Cm purge
.Cm unload
all modules
.Pp
.It Cm refresh
Reload aliases from current list of modules.
.Pp
.It Cm update
Reload all currently loaded modules.
.El
.Ss SEARCH
.Bl -tag -width Ds -compact
.It Cm list
List all loaded modules.
.Pp
.It Cm list Ar s1 Op Ar s2 ...
List all loaded modules that match any of the given patterns.
.Pp
.It Cm avail , av Op Ar string
List all available modules.
Restricts to modules containing
.Ar string
if it is provided.
.Pp
.It Cm spider Ar module
List all possible versions of that
.Ar module
file.
.Pp
.It Cm spider Ar string
List all modules that contain
.Ar string .
.Pp
.It Cm spider Ar name/version
Detailed information about that version of the module.
.Pp
.It Cm whatis Ar module
Print whatis information about the module.
.Pp
.It Cm keyword , key Ar string
Search all name and
.Cm whatis
that contain
.Ar string .
.El
.Pp
All searching commands (
.Cm spider ,
.Cm list ,
.Cm avail ,
.Cm keyword
) support regular expressions.
.Pp
For example, to find all modules that start with
.Sq p
or
.Sq P :
.D1 module -r spider '^p'
.Pp
Find all modules that have
.Dq mpi
in their name:
.D1 module -r spider mpi
.Pp
Find all modules that end with
.Dq mpi
in their name:
.D1 module -r spider 'mpi$'
.Ss COLLECTIONS
.Bl -tag -width Ds -compact
.It Cm save , s
Save the current list of modules to a user defined
.Dq default
collection.
.Pp
.It Cm save , s Ar name
Save the current list of modules to the
.Ar name
collection.
.Pp
.It Cm reset
The same as
.Cm restore
.Ar system .
.Pp
.It Cm restore , r
Restore modules from the user's
.Dq default
(if defined) or the system default.
.Pp
.It Cm restore , r Ar name
Restore modules from
.Ar name
collection.
.Pp
.It Cm restore Ar system
Restore module state to system defaults.
.Pp
.It Cm savelist
List of saved collections.
.Pp
.It Cm describe , mcc Ar name
Describe the contents of the
.Ar name
module collection.
.Pp
.It Cm disable Ar name
Disable (i.e. remove) the
.Ar name
collection.
.El
.Ss DEPRECATED
.Bl -tag -width Ds -compact
.It Cm getdefault Op Ar name
Load the
.Ar name
collection of modules or users
.Dq default
if no
.Ar name
given.
.Pp
Use
.Cm restore
Instead.
.Pp
.It Cm setdefault Op Ar name
Save current list of modules to
.Ar name
if given, otherwise save as the
.Dq default
list for the user.
.Pp
Use
.Cm save
instead.
.El
.Ss MISC
.Bl -tag -width Ds -compact
.It Cm is-loaded Ar modulefile
Return a true status if
.Ar module
is loaded.
.Pp
.It Cm is-avail Ar modulefile
Return a true status if
.Ar module
can be loaded.
.Pp
.It Cm show Ar modulefile
Show the commands in the
.Ar module
file.
.Pp
.It Cm use [-a] Ar path
Prepend or append
.Ar path
to
.Ev MODULEPATH .
.Pp
.It Cm unuse Ar path
Remove
.Ar path
from
.Ev MODULEPATH .
.Pp
.It Cm tablelist
Output list of active modules as a lua table.
.El
.Sh ENVIRONMENT
To print properties and warnings in color, set the
.Ev LMOD_COLORIZE
environment variable to
.Sy YES
.Sh SEE ALSO
.Bd -filled -offset indent
.TS
allbox tab(@);
le lw10.
Documentation@http://lmod.readthedocs.org
Github@https://github.com/TACC/Lmod
Sourceforge@https://lmod.sf.net
TACC Homepage@https://www.tacc.utexas.edu/research-development/tacc-projects/lmod
.TE
.Ed
.Pp
To report a bug please read
.Lk http://lmod.readthedocs.io/en/latest/075_bug_reporting.html
.Sh AUTHORS
Modules based on Lua, written by
.An Robert McLay Aq Mt mclay@tacc.utexas.edu .
.Pp
The man page for Gentoo linux is maintained by the
.An Gentoo Science Project <sci@gentoo.org> .

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: Allowing "?" as a flag in mdoc
  2021-01-24 15:39 Allowing "?" as a flag in mdoc Aisha Tammy
  2021-01-24 15:49 ` Aisha Tammy
@ 2021-01-24 17:01 ` Raf Czlonka
  2021-01-24 17:04   ` Aisha Tammy
  1 sibling, 1 reply; 6+ messages in thread
From: Raf Czlonka @ 2021-01-24 17:01 UTC (permalink / raw)
  To: Aisha Tammy; +Cc: discuss

On Sun, Jan 24, 2021 at 03:39:19PM GMT, Aisha Tammy wrote:
> Hi,
>   I'm trying to create a manpage where the command takes a flag "?"
> The command would (to display help):
>   module -?
> 
> For this I created in module.1:
> 
> .Bl -tag -width Ds -compact
> .It Fl h , ? , H , -help
> Show the help message.
> .El
> 
> But the output of this looks:
> 
>      -h,?, -H, --help
>              Show the help message.
> 
> Without the - before ?
> 
> Can anyone tell how I can display a -? before the flag?
> 
> Thanks,
> Aisha

Hi Aisha,

Prepend it with zero-width space ('\&').[0]

[0] https://man.openbsd.org/mdoc.7#Delimiters

Regards,

Raf
--
 To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv


^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: Allowing "?" as a flag in mdoc
  2021-01-24 17:01 ` Raf Czlonka
@ 2021-01-24 17:04   ` Aisha Tammy
  2021-01-24 17:10     ` Raf Czlonka
  0 siblings, 1 reply; 6+ messages in thread
From: Aisha Tammy @ 2021-01-24 17:04 UTC (permalink / raw)
  To: discuss



On 1/24/21 12:01 PM, Raf Czlonka wrote:
> On Sun, Jan 24, 2021 at 03:39:19PM GMT, Aisha Tammy wrote:
>> Hi,
>>   I'm trying to create a manpage where the command takes a flag "?"
>> The command would (to display help):
>>   module -?
>>
>> For this I created in module.1:
>>
>> .Bl -tag -width Ds -compact
>> .It Fl h , ? , H , -help
>> Show the help message.
>> .El
>>
>> But the output of this looks:
>>
>>      -h,?, -H, --help
>>              Show the help message.
>>
>> Without the - before ?
>>
>> Can anyone tell how I can display a -? before the flag?
>>
>> Thanks,
>> Aisha
> 
> Hi Aisha,
> 
> Prepend it with zero-width space ('\&').[0]
> 
> [0] https://man.openbsd.org/mdoc.7#Delimiters
> 

Thanks a lot!

Aisha
> Regards,
> 
> Raf
> --
>  To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv
> 
--
 To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv


^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: Allowing "?" as a flag in mdoc
  2021-01-24 17:04   ` Aisha Tammy
@ 2021-01-24 17:10     ` Raf Czlonka
  2021-01-24 17:36       ` Aisha Tammy
  0 siblings, 1 reply; 6+ messages in thread
From: Raf Czlonka @ 2021-01-24 17:10 UTC (permalink / raw)
  To: Aisha Tammy; +Cc: discuss

On Sun, Jan 24, 2021 at 05:04:06PM GMT, Aisha Tammy wrote:
> 
> On 1/24/21 12:01 PM, Raf Czlonka wrote:
> > On Sun, Jan 24, 2021 at 03:39:19PM GMT, Aisha Tammy wrote:
> >> Hi,
> >>   I'm trying to create a manpage where the command takes a flag "?"
> >> The command would (to display help):
> >>   module -?
> >>
> >> For this I created in module.1:
> >>
> >> .Bl -tag -width Ds -compact
> >> .It Fl h , ? , H , -help
> >> Show the help message.
> >> .El
> >>
> >> But the output of this looks:
> >>
> >>      -h,?, -H, --help
> >>              Show the help message.
> >>
> >> Without the - before ?
> >>
> >> Can anyone tell how I can display a -? before the flag?
> >>
> >> Thanks,
> >> Aisha
> > 
> > Hi Aisha,
> > 
> > Prepend it with zero-width space ('\&').[0]
> > 
> > [0] https://man.openbsd.org/mdoc.7#Delimiters
> > 
> 
> Thanks a lot!
> 
> Aisha

Hello,

Two things, though:

1. Not sure whether using a question mark ('?') as a flag is a good idea.

2. module(1) is already taken[1] ;^)

[1] http://modules.sourceforge.net/

Cheers,

Raf
--
 To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv


^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: Allowing "?" as a flag in mdoc
  2021-01-24 17:10     ` Raf Czlonka
@ 2021-01-24 17:36       ` Aisha Tammy
  0 siblings, 0 replies; 6+ messages in thread
From: Aisha Tammy @ 2021-01-24 17:36 UTC (permalink / raw)
  To: Raf Czlonka; +Cc: discuss

I am not the one making this package.
This package is https://github.com/TACC/Lmod/
which is an alternative (imo better) implementation of standard
tk environment modules.
It does not provide a nice man page, I'm maintaining this for
Gentoo Linux and decided to create a better man page in mdoc.

Cheers,
Aisha

On 1/24/21 12:10 PM, Raf Czlonka wrote:
> On Sun, Jan 24, 2021 at 05:04:06PM GMT, Aisha Tammy wrote:
>>
>> On 1/24/21 12:01 PM, Raf Czlonka wrote:
>>> On Sun, Jan 24, 2021 at 03:39:19PM GMT, Aisha Tammy wrote:
>>>> Hi,
>>>>   I'm trying to create a manpage where the command takes a flag "?"
>>>> The command would (to display help):
>>>>   module -?
>>>>
>>>> For this I created in module.1:
>>>>
>>>> .Bl -tag -width Ds -compact
>>>> .It Fl h , ? , H , -help
>>>> Show the help message.
>>>> .El
>>>>
>>>> But the output of this looks:
>>>>
>>>>      -h,?, -H, --help
>>>>              Show the help message.
>>>>
>>>> Without the - before ?
>>>>
>>>> Can anyone tell how I can display a -? before the flag?
>>>>
>>>> Thanks,
>>>> Aisha
>>>
>>> Hi Aisha,
>>>
>>> Prepend it with zero-width space ('\&').[0]
>>>
>>> [0] https://man.openbsd.org/mdoc.7#Delimiters
>>>
>>
>> Thanks a lot!
>>
>> Aisha
> 
> Hello,
> 
> Two things, though:
> 
> 1. Not sure whether using a question mark ('?') as a flag is a good idea.
> 
> 2. module(1) is already taken[1] ;^)
> 
> [1] http://modules.sourceforge.net/
> 
> Cheers,
> 
> Raf
> 
--
 To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv


^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2021-01-24 17:36 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-01-24 15:39 Allowing "?" as a flag in mdoc Aisha Tammy
2021-01-24 15:49 ` Aisha Tammy
2021-01-24 17:01 ` Raf Czlonka
2021-01-24 17:04   ` Aisha Tammy
2021-01-24 17:10     ` Raf Czlonka
2021-01-24 17:36       ` Aisha Tammy

discuss@mandoc.bsd.lv

This inbox may be cloned and mirrored by anyone:

	git clone --mirror http://inbox.vuxu.org/mandoc-discuss

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V1 mandoc-discuss mandoc-discuss/ http://inbox.vuxu.org/mandoc-discuss \
		discuss@mandoc.bsd.lv
	public-inbox-index mandoc-discuss

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://inbox.vuxu.org/vuxu.archive.mandoc.discuss


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git