From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mout-p-202.mailbox.org (mout-p-202.mailbox.org [80.241.56.172]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mail.server123.net (Postfix) with ESMTPS for ; Thu, 22 Oct 2020 11:38:15 +0200 (CEST) Received: from smtp1.mailbox.org (smtp1.mailbox.org [IPv6:2001:67c:2050:105:465:1:1:0]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-384) server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by mout-p-202.mailbox.org (Postfix) with ESMTPS id 4CH2NN4G5TzQlRB for ; Thu, 22 Oct 2020 11:38:12 +0200 (CEST) Received: from smtp1.mailbox.org ([80.241.60.240]) by spamfilter03.heinlein-hosting.de (spamfilter03.heinlein-hosting.de [80.241.56.117]) (amavisd-new, port 10030) with ESMTP id bJEf19wuk9iD for ; Thu, 22 Oct 2020 11:38:04 +0200 (CEST) Date: Thu, 22 Oct 2020 11:37:51 +0200 In-Reply-To: <632166d2-4306-522b-7806-0ba76bddcbcb@gmail.com> References: <50f5c0f9-701c-f80b-3e07-6b040aa3101e@gmail.com> <29bb2e5b-5509-9ebc-8a9a-fec09842910f@my-it-brain.de> <632166d2-4306-522b-7806-0ba76bddcbcb@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable From: =?ISO-8859-1?Q?J=F6rg_Kastning?= Message-ID: Subject: Re: [dm-crypt] Do you accept contributions to manpage via patch? List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: dm-crypt@saout.de Am 22=2E Oktober 2020 10:36:07 MESZ schrieb Milan Broz : >On 20/10/2020 21:53, J=C3=B6rg Kastning wrote: [=2E=2E=2E]=20 >But I have some notes before I can merge this=2E > >- the example section - one example how to use --type is perhaps ok, >but definitely >normal user should never use this option=2E I will remove it from example >2 and 3=2E That's OK for me=2E >- example 5 needs a strong warning, this command make the LUKS device >unusable=2E >(but still detected as LUKS block device)=2E It is really meant only for >data destruction >by removing all volume keys slots from header=2E Would you like to add the warning? If you like I can add it an resubmit th= e patch again=2E >- please, is really your name in the man page necessary? >There are a lot of contributors not mentioned there=2E >This is quite trivial change and we track authors of such small changes >through git >commits only (I will reformat it so you are the patch author in git; or >you can use >use git format-patch) > >But in general, yes, we are missing the examples section there=2E=2E=2E >strange :) It's not necessary to mention my name in the manpage=2E I put it there bec= ause I didn't find any contribution guidelines and didn't know where else t= o put it=2E If you Set it as commit author I'm fine with it=2E Regards, Joerg=20 >*** 1490,1495 **** >--- 1490,1514 ---- > =2ETP > =2EB "\-\-help, \-?" > Show help text and default parameters=2E >+ =2ESH EXAMPLE >+ =2ETP >+ Example 1: Create LUKS 2 container on block device /dev/sdX=2E >+ sudo cryptsetup --type luks2 luksFormat /dev/sdX >+ =2ETP >+ Example 2: Add an additional passphrase to key slot 5=2E >+ sudo cryptsetup --type luks2 luksAddKey --key-slot 5 /dev/sdX >+ =2ETP >+ Example 3: Create LUKS header backup and save it to file=2E >+ sudo cryptsetup --type luks2 luksHeaderBackup /dev/sdX >--header-backup-file /var/tmp/NameOfBackupFile >+ =2ETP >+ Example 4: Open LUKS contaner on /dev/sdX and map it to sdX_crypt=2E >+ sudo cryptsetup open /dev/sdX sdX_crypt >+ =2ETP >+ Example 5: Erase all key slots on /dev/sdX=2E >+ sudo cryptsetup erase /dev/sdX >+ =2ETP >+ Example 6: Restore LUKS header from backup file=2E >+ sudo cryptsetup luksHeaderRestore /dev/sdX --header-backup-file >/var/tmp/NameOfBackupFile > =2ESH RETURN CODES > Cryptsetup returns 0 on success and a non-zero value on error=2E > =20 >*************** >*** 1710,1715 **** >--- 1729,1736 ---- > Man page extensions by Milan Broz =2E > =2Ebr > Man page rewrite and extension by Arno Wagner =2E >+ =2Ebr >+ Add Examples and minor rewrite by Joerg Kastning >=2E > =2ESH COPYRIGHT > Copyright \(co 2004 Jana Saout > =2Ebr >_______________________________________________ >dm-crypt mailing list >dm-crypt@saout=2Ede >https://www=2Esaout=2Ede/mailman/listinfo/dm-crypt --=20 E-Mail: joerg=2Ekastning@my-it-brain=2Ede Twitter: https://twitter=2Ecom/JoergKastning Internet: https://www=2Emy-it-brain=2Ede Threema-ID: K2Y6W49N OpenPGP-ID: 7A302E30 OpenPGP-Fingerabdruck: 2026 DF56 89B6 F79A E776 B15B 55E2 83FB 7A30 2E30