Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add EXAMPLE sections to man pages #301

Open
ericonr opened this issue Jul 3, 2020 · 4 comments
Open

Add EXAMPLE sections to man pages #301

ericonr opened this issue Jul 3, 2020 · 4 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@ericonr
Copy link
Member

ericonr commented Jul 3, 2020

This is something that might have been solved by the Rosetta stone docs page too, but I think we can fix it by having EXAMPLEs in all the man pages, for common use cases. Flag composition might not be obvious to users coming from other distros.

@Duncaen Duncaen added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Jul 3, 2020
@flexibeast
Copy link
Contributor

flexibeast commented Jul 23, 2020

i'm happy to work on this.

@Chocimier
Copy link
Member

I would love to see some nontrivial examples, like

  • list installed self-build packages (I use xbps-query --regex -p repository -s / | grep -v -e ' https://' -e ': /hostdir' | cut -d: -f1
  • create package depending on packages needed to build ksysguard on host
p=ksysguard
. $(xdistdir)/srcpkgs/${p}/template
xbps-create -n ${p}-build-deps-${version}_${revision} \
 -s "Build depends of ${p}" -A "$(xbps-uhelper arch)" \
 -D "$(echo $hostmakedepends $makedepends | sed 's/ />=0 /g')>=0" \
 $(mktemp -d)

@flexibeast
Copy link
Contributor

@Chocimier: xbps-query example added to #310, xbps-create example added in #314.

@npranav7619
Copy link

Can I look into this ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

5 participants