Changeset 281


Ignore:
Timestamp:
01/19/2009 16:08:58 (3 years ago)
Author:
ccowart
Message:

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

Location:
trunk
Files:
1 added
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/confman.8

    r280 r281  
    7575.It singularity 
    7676A singularity is a file that is constructed from components in each module 
    77 of the recipe.   
    78 .Pp 
    79 For example, assume we have a recipe with the contents: 
    80 .Pp 
    81 .Dl "core" 
    82 .Dl "www" 
    83 .Pp 
    84 Next, assume that we have configured the file "/etc/rc.conf" as a singularity. 
    85 We will have two pieces of this file in our working copy: 
    86 .Pp 
    87 ~/src/conf/core/etc/rc.conf-core: 
    88 .Pp 
    89 .Dl sshd_enable="YES" 
    90 .Dl usbd_enable="YES" 
    91 .Dl accounting_enable="YES" 
    92 .Pp 
    93 ~/src/conf/www/etc/rc.conf-www: 
    94 .Pp 
    95 .Dl apache22_enable="YES" 
    96 .Pp 
    97 The resulting "/etc/rc.conf" that will be installed upon an install or commit 
    98 operation is the concatenation of the pieces: 
    99 .Pp 
    100 .Dl sshd_enable="YES" 
    101 .Dl usbd_enable="YES" 
    102 .Dl accounting_enable="YES" 
    103 .Dl apache22_enable="YES" 
     77of the recipe. See the 
     78.Sx SINGULARITIES 
     79subsection of 
     80.Sx EXAMPLES 
     81for an example of how this works. 
     82.It state 
     83A system can either be in a dirty or clean state.  
     84A dirty system is one that has missed a  
     85.Xr confsync 8 operation in order to preserve changes made by installation 
     86operations occurring between the repository's  
     87.Xr confexport 8 and the invocation of 
     88.Cm confsync . 
     89.Pp 
     90Dirty systems may have out-of-date configuration files. Subsequent  
     91.Cm confsync  
     92or 
     93.Nm 
     94.Cm commit 
     95operations can bring the system up-to-date. 
    10496.El 
    10597.\" TODO 
    106 .Pp 
    107 This doesn't belong here, but I don't want to forget it:  
    108 .Pp 
    109 A dirty system is one that has missed an automated "sync" operation in order 
    110 to preserve changes made by installation operations occurring between the 
    111 repository's export and the system's call to "sync." 
    112 .Pp 
    113 Dirty systems may have out-of-date configuration files. Subsequent sync or 
    114 commit operations can bring the system up-to-date. 
    11598.Ss COMMANDS 
    11699The following commands are supported by  
    … …  
    298281This small set of examples should be enough to demonstrate some common use 
    299282cases for new users. We assume a default working copy location of  
    300 "~/src/conf".  
    301 .Pp 
     283"~/src/conf", and paths in these examples will be relative to this directory. 
     284.Ss MODULES 
    302285First, we will create a module named core: 
    303286.Pp 
    … …  
    312295.Pp 
    313296.Dl "confman create marvin" 
    314 .Pp 
     297.Ss RECIPES 
    315298Now let's generate marvin's recipe: 
    316299.Pp 
    … …  
    327310.Pp 
    328311.Dl "confman recipe set marvin" 
    329 .Pp 
     312.Ss WORKING WITH FILES 
    330313Files have to be imported into 
    331314.Nm 
    … …  
    336319.Pp 
    337320In order to make a change to /etc/resolv.conf, we will modify the working 
    338 copy found in ~/src/conf/core/etc/resolv.conf. We'll add a domain to our 
    339 search path. Next, we'll also make some changes to  
    340 ~/src/conf/core/etc/periodic.conf. Once we're all set, we will commit our 
    341 changes: 
     321copy found in core/etc/resolv.conf. We'll add a domain to our 
     322search path. Next, we'll also make some changes to core/etc/periodic.conf.  
     323Once we're all set, we will commit our changes: 
    342324.Pp 
    343325.Dl "confman commit" 
    … …  
    347329repository for other servers to see, but until some action is taken, they 
    348330will not be rolled out. 
    349 .Pp 
     331.Ss SINGULARITIES 
    350332Now let's assume that we have configured /etc/rc.conf as a singularity  
    351333(See 
    … …  
    357339.Dl "confman import marvin /etc/rc.conf" 
    358340.Pp 
     341We will put our globally relevant options in the core portion  
     342(core/etc/rc.conf-core): 
     343.Pp 
     344.Dl sshd_enable="YES" 
     345.Dl usbd_enable="YES" 
     346.Dl accounting_enable="YES" 
     347.Pp 
     348And our host-specific configurations in the marvin portion 
     349(www/etc/rc.conf-marvin): 
     350.Pp 
     351.Dl apache22_enable="YES" 
     352.Pp 
     353The resulting "/etc/rc.conf" that will be installed upon an install or commit 
     354operation is the concatenation of the pieces: 
     355.Pp 
     356.Dl sshd_enable="YES" 
     357.Dl usbd_enable="YES" 
     358.Dl accounting_enable="YES" 
     359.Dl apache22_enable="YES" 
    359360.Sh SEE ALSO 
    360361.Xr confman.conf 5 , 
Note: See TracChangeset for help on using the changeset viewer.