man/man1/vmm.1
branchv0.6.x
changeset 473 9b9cccebccf0
parent 432 ad7cfbfbc68d
child 475 e321b764268e
equal deleted inserted replaced
472:8f59a2f539e7 473:9b9cccebccf0
     1 .TH "VMM" "1" "2011-02-24" "vmm 0.6" "vmm"
     1 .TH "VMM" "1" "2011-11-09" "vmm 0.6" "vmm"
     2 .SH NAME
     2 .SH NAME
     3 vmm \- command line tool to manage email domains/accounts/aliases
     3 vmm \- command line tool to manage email domains/accounts/aliases
     4 .\" -----------------------------------------------------------------------
     4 .\" -----------------------------------------------------------------------
     5 .SH SYNOPSIS
     5 .SH SYNOPSIS
     6 .B vmm
     6 .B vmm
   253         [\-]     example.name
   253         [\-]     example.name
   254         [+] example.net
   254         [+] example.net
   255         [+] example.org
   255         [+] example.org
   256 .fi
   256 .fi
   257 .\" ------------------------------------
   257 .\" ------------------------------------
       
   258 .SS listpwschemes (lp)
       
   259 .B vmm listpwschemes
       
   260 .PP
       
   261 This subcommand lists all password schemes which could be used in the
       
   262 .I vmm.cfg
       
   263 as value of the
       
   264 .I misc.password_scheme
       
   265 option.
       
   266 The output varies, depending on the used Dovecot version and the system's
       
   267 libc.
       
   268 .br
       
   269 When your Dovecot installation isn't too old, you will see additionally a
       
   270 few usable encoding suffixes.
       
   271 One of them can be appended to the password scheme.
       
   272 .PP
       
   273 Example:
       
   274 .PP
       
   275 .nf
       
   276 .B vmm listpwschemes
       
   277 Usable password schemes
       
   278 -----------------------
       
   279         CRYPT SHA512-CRYPT LDAP-MD5 DIGEST-MD5 SHA256 SHA512 SSHA512
       
   280         SKEY SSHA NTLM RPA MD5-CRYPT HMAC-MD5 SHA1 PLAIN SHA CRAM-MD5
       
   281         SSHA256 MD5 LANMAN CLEARTEXT PLAIN-MD5 PLAIN-MD4 OTP SMD5
       
   282         SHA256-CRYPT
       
   283 
       
   284 Usable encoding suffixes
       
   285 ------------------------
       
   286         .B64 .BASE64 .HEX
       
   287 .fi
       
   288 .\" ------------------------------------
   258 .SS version (v)
   289 .SS version (v)
   259 .B vmm version
   290 .B vmm version
   260 .PP
   291 .PP
   261 Prints
   292 Prints
   262 .BR vmm 's
   293 .BR vmm 's
   401 Example:
   432 Example:
   402 .PP
   433 .PP
   403 .nf
   434 .nf
   404 .B vmm domainquota example.com 1g force
   435 .B vmm domainquota example.com 1g force
   405 .fi
   436 .fi
       
   437 .\" ------------------------------------
       
   438 .SS domainservices (ds)
       
   439 .B vmm domainservices
       
   440 .IR fqdn " [" "service ..." ]
       
   441 .RB [ force ]
       
   442 .PP
       
   443 To define which services could be used by the users of the domain \(em with
       
   444 the given
       
   445 .I fqdn
       
   446 \(em use this subcommand.
       
   447 .PP
       
   448 Each specified
       
   449 .I service
       
   450 will be enabled/usable.
       
   451 All other services will be deactivated/unusable.
       
   452 Possible service names are: 
       
   453 .BR  imap ", " pop3 ", " sieve " and " smtp .
       
   454 .br
       
   455 When the keyword
       
   456 .B force
       
   457 was omitted, the service setting will be the default for new created
       
   458 accounts.
       
   459 Otherwise it will additionally apply the settings to all existing accounts
       
   460 of the domain.
   406 .\" ------------------------------------
   461 .\" ------------------------------------
   407 .SS domaintransport (dt)
   462 .SS domaintransport (dt)
   408 .BI "vmm domaintransport" " fqdn transport"
   463 .BI "vmm domaintransport" " fqdn transport"
   409 .RB [ force ]
   464 .RB [ force ]
   410 .PP
   465 .PP
   542 If there are one or more aliases with an identical destination address,
   597 If there are one or more aliases with an identical destination address,
   543 .B vmm
   598 .B vmm
   544 will abort the requested operation and show an error message.
   599 will abort the requested operation and show an error message.
   545 To prevent this, specify the optional keyword
   600 To prevent this, specify the optional keyword
   546 .BR force .
   601 .BR force .
   547 .\" ------------------------------------
       
   548 .SS userdisable (u0)
       
   549 .BI "vmm userdisable" " address"
       
   550 .RI [ "service ..." ]
       
   551 .PP
       
   552 If a user should not be able to access one or more services you can
       
   553 restrict the user's access with this subcommand.
       
   554 .PP
       
   555 If no
       
   556 .I service
       
   557 was given all services
       
   558 .RB ( imap ", " pop3 ", " sieve " and " smtp )
       
   559 will be disabled for the account with the specified
       
   560 .IR address .
       
   561 Otherwise only the specified
       
   562 .IR service (s)
       
   563 will be restricted.
       
   564 .PP
       
   565 Examples:
       
   566 .PP
       
   567 .nf
       
   568 .B vmm u0 b.user@example.com imap pop3
       
   569 .B vmm userdisable c.user@example.com
       
   570 .fi
       
   571 .\" ------------------------------------
       
   572 .SS userenable (u1)
       
   573 .BI "vmm userenable" " address"
       
   574 .RI [ "service ..." ]
       
   575 .PP
       
   576 To allow access to one or more restricted
       
   577 .IR service (s)
       
   578 use this subcommand.
       
   579 .PP
       
   580 If no
       
   581 .I service
       
   582 was given all services
       
   583 .RB ( imap ", " pop3 ", " sieve " and " smtp )
       
   584 will be enabled for the account with the specified
       
   585 .IR address .
       
   586 Otherwise only the specified
       
   587 .IR service (s)
       
   588 will be enabled.
       
   589 .\" ------------------------------------
   602 .\" ------------------------------------
   590 .SS userinfo (ui)
   603 .SS userinfo (ui)
   591 .B "vmm userinfo"
   604 .B "vmm userinfo"
   592 .IR address " [" details ]
   605 .IR address " [" details ]
   593 .PP
   606 .PP
   688 .PP
   701 .PP
   689 .nf
   702 .nf
   690 .B vmm userquota d.user@example.com 750m
   703 .B vmm userquota d.user@example.com 750m
   691 .fi
   704 .fi
   692 .\" ------------------------------------
   705 .\" ------------------------------------
       
   706 .SS userservices (us)
       
   707 .B vmm userservices
       
   708 .IR address " [" "service ..." ]
       
   709 .PP
       
   710 To grant a user access to the specified services, use this command.
       
   711 .PP
       
   712 All omitted services will be deactivated/unusable for the user with the
       
   713 given
       
   714 .IR address .
       
   715 .\" ------------------------------------
   693 .SS usertransport (ut)
   716 .SS usertransport (ut)
   694 .BI "vmm usertransport" " address transport"
   717 .BI "vmm usertransport" " address transport"
   695 .PP
   718 .PP
   696 A different
   719 A different
   697 .I transport
   720 .I transport