Ticket #8 (closed task: fixed)

Opened 3 years ago

Last modified 3 years ago

Write a man page

Reported by: ccowart Owned by: ccowart
Priority: major Milestone: confman-1.9b
Component: Documentation Version: 1.7.2
Keywords: Cc:

Description

Currently, confman lacks a man page. This needs to be remedied.

Change History

comment:1 Changed 3 years ago by ccowart

(In [279]) * Created a man page

  • Reproduced much of confmandoc.sh in the DESCRIPTION section. I think we should remove all but the usage statements from the built-in help.
  • Some Big Ideas and examples as well as a pass at organization are still needed to make this baby complete.
  • The Makefile doesn't know anything about it yet.

See #8

comment:2 Changed 3 years ago by ccowart

(In [280]) * Created a GLOSSARY subsection with some useful terms.

  • Filled in some of the SEE ALSO section
  • Cleaned up some of the markup throughout
  • Started, but did not complete, the EXAMPLES section

See #8

comment:3 Changed 3 years ago by ccowart

  • Owner set to ccowart
  • Status changed from new to accepted

comment:4 Changed 3 years ago by ccowart

(In [281]) More man page work.

  • Cleaned up organization of singularity example for confman.8.
  • Used subsections to better organize the EXAMPLES section.
  • Added references to other utilities
  • Created first pass of confman.conf.5

See #8

comment:5 Changed 3 years ago by ccowart

(In [282]) Forgot a few options in confman.conf.
See #8

comment:6 Changed 3 years ago by ccowart

(In [285]) Created a man page for confsync.

See #8

comment:7 Changed 3 years ago by ccowart

(In [288]) More work on man pages.

  • Created page for confexport.8
  • Added SECURITY CONSIDERATIONS section to confsync.8

See #8

comment:8 Changed 3 years ago by ccowart

(In [289]) Created confaudit.8 man page.

Note that man pages are not yet handled by the Makefile.

See #8

comment:9 Changed 3 years ago by ccowart

(In [290]) Documented -q flag.

See #8

comment:10 Changed 3 years ago by ccowart

(In [299]) Makefile cleanup.

  • Renaming executables to drop .sh suffix.
  • Updating directory handling in Makefile
  • Getting man pages into Makefile

See #8

comment:11 Changed 3 years ago by ccowart

(In [316]) Documenting recent confadmin work in its man page.

See #8
See #20

comment:12 Changed 3 years ago by ccowart

(In [317])

  • Made make aware of the confadmin man page
  • Fixed disagreement between repository structure between confman setup and confadmin setup
  • Templatized log message

See #8
See #24
See #20

comment:13 Changed 3 years ago by ccowart

  • Status changed from accepted to closed
  • Resolution set to fixed

(In [320]) With the security considerations section done, the man pages are pretty
much up-to-date.

Fixes #8

Note: See TracTickets for help on using tickets.