man/man1/vmm.1
branchv0.7.x
changeset 690 06c0acf6c45d
parent 688 c14299bc1b99
child 691 932cd76bf879
equal deleted inserted replaced
689:dab0630947a2 690:06c0acf6c45d
     1 .TH "VMM" "1" "2013-01-19" "vmm 0.7" "vmm"
     1 .TH "VMM" "1" "2013-01-20" "vmm 0.7" "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
   587 .B vmm domaintransport support.example.com dovecot:
   587 .B vmm domaintransport support.example.com dovecot:
   588 .fi
   588 .fi
   589 .\" ------------------------------------
   589 .\" ------------------------------------
   590 .SS domainnote (do)
   590 .SS domainnote (do)
   591 .BI "vmm domainnote" " fqdn"
   591 .BI "vmm domainnote" " fqdn"
   592 .RB [ \-n
   592 .BR \-d | \-n
   593 .IR note ]
   593 .I note
       
   594 .PP
       
   595 .\" ------------------------------------
       
   596 .TP
       
   597 .B \-d
       
   598 delete the domain\(aqs note.
       
   599 .\" ------------------------------------
       
   600 .TP
       
   601 .BI "\-n " note
       
   602 the note that should be set.
       
   603 .\" ------------------------------------
   594 .PP
   604 .PP
   595 With this subcommand, it is possible to attach a note to the specified
   605 With this subcommand, it is possible to attach a note to the specified
   596 domain. Without an argument, an existing note is removed.
   606 domain.
       
   607 In order to delete an existing note, pass the
       
   608 .BR \-d " option."
   597 .PP
   609 .PP
   598 Example:
   610 Example:
   599 .PP
   611 .PP
   600 .nf
   612 .nf
   601 .B vmm do example.com \-n `Belongs to Robert'
   613 .B vmm do example.com \-n `Belongs to Robert'
   795         SIEVE............: enabled
   807         SIEVE............: enabled
   796 .fi
   808 .fi
   797 .\" ------------------------------------
   809 .\" ------------------------------------
   798 .SS username (un)
   810 .SS username (un)
   799 .BI "vmm username" " address"
   811 .BI "vmm username" " address"
   800 .RB [ \-n
   812 .BR \-d | \-n
   801 .IR name ]
   813 .IR name
       
   814 .PP
       
   815 .\" ------------------------------------
       
   816 .TP
       
   817 .B \-d
       
   818 delete the user\(aqs name.
       
   819 .\" ------------------------------------
       
   820 .TP
       
   821 .BI "\-n " name
       
   822 a user\(aqs real name.
       
   823 .\" ------------------------------------
   802 .PP
   824 .PP
   803 The user's real
   825 The user's real
   804 .I name
   826 .I name
   805 can be set/updated with this subcommand.
   827 can be set/updated with this subcommand.
   806 .PP
   828 .PP
   807 If no
   829 In order to delete the value stored for the account, pass the
   808 .I name
   830 .BR \-d " option."
   809 is given, the value stored for the account is erased.
       
   810 .PP
   831 .PP
   811 Example:
   832 Example:
   812 .PP
   833 .PP
   813 .nf
   834 .nf
   814 .B vmm un d.user@example.com \-n \(dqJohn Doe\(dq
   835 .B vmm un d.user@example.com \-n \(dqJohn Doe\(dq
   833 .B vmm up d.user@example.com \-p \(dqA |\(rs/|0r3 5ecur3 P4s5\(rs/\(rs/0rd?\(dq
   854 .B vmm up d.user@example.com \-p \(dqA |\(rs/|0r3 5ecur3 P4s5\(rs/\(rs/0rd?\(dq
   834 .fi
   855 .fi
   835 .\" ------------------------------------
   856 .\" ------------------------------------
   836 .SS usernote (uo)
   857 .SS usernote (uo)
   837 .BI "vmm usernote" " address"
   858 .BI "vmm usernote" " address"
   838 .RB [ \-n
   859 .BR \-d | \-n
   839 .IR note ]
   860 .IR note
       
   861 .PP
       
   862 .\" ------------------------------------
       
   863 .TP
       
   864 .B \-d
       
   865 delete the user\(aqs note.
       
   866 .\" ------------------------------------
       
   867 .TP
       
   868 .BI "\-n " note
       
   869 the note that should be set.
       
   870 .\" ------------------------------------
   840 .PP
   871 .PP
   841 With this subcommand, it is possible to attach a note to the specified
   872 With this subcommand, it is possible to attach a note to the specified
   842 account. Without an argument, an existing note is removed.
   873 account.
       
   874 In order to delete an existing note, pass the
       
   875 .BR \-d " option."
   843 .PP
   876 .PP
   844 Example:
   877 Example:
   845 .PP
   878 .PP
   846 .nf
   879 .nf
   847 .B vmm uo d.user@example.com -n `Only needed until end of May 2013'
   880 .B vmm uo d.user@example.com -n `Only needed until end of May 2013'