Bug 500797

Summary: ``file'' is not an optional argument in `ecryptfs-rewrap-passphrase command', but ``-'' is
Product: Red Hat Enterprise Linux 5 Reporter: Michal Nowak <mnowak>
Component: ecryptfs-utilsAssignee: Michal Hlavinka <mhlavink>
Status: CLOSED CANTFIX QA Contact: BaseOS QE <qe-baseos-auto>
Severity: low Docs Contact:
Priority: low    
Version: 5.4CC: ohudlick
Target Milestone: rc   
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2009-05-18 14:32:22 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Michal Nowak 2009-05-14 09:28:50 UTC
Description of problem:

"""
SYNOPSIS
       ecryptfs-rewrap-passphrase [file]

       printf "%s\n%s"  "old  wrapping  passphrase"  "new  wrapping  passphrase"  |  ecryptfs-rewrap-
       passphrase [file] -
"""

The description is wrong, because the ``file'' is necessary to be present in the command line, otherwise:

May 14 05:01:55 hp-ml370g4-01 ecryptfs-insert-wrapped-passphrase-into-keyring: Error attempting to open [-] for reading 

Version-Release number of selected component (if applicable):

ecryptfs-utils-75-1.el5

Expected results:

Remove '[' and ']' around ``file'', add them to ``-''.

It's probably the same for all ecryptfs-*wrap* man pages.

Comment 1 Michal Hlavinka 2009-05-18 14:22:39 UTC
I don't know about any standard reflecting [] usable only for optional arguments and without this I can hardly convince upstream that this change is worthwhile.

note: there are other man pages using [] for non-optional arguments (for example man tee).

Comment 2 Michal Nowak 2009-05-18 14:32:22 UTC
Nor do I. Closing, since we don't have an authoritative source.