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

sysdig manual needs to be updated #2046

Open
unknowndevQwQ opened this issue Dec 9, 2023 · 5 comments
Open

sysdig manual needs to be updated #2046

unknowndevQwQ opened this issue Dec 9, 2023 · 5 comments

Comments

@unknowndevQwQ
Copy link

The following problem was found in the manual packaged with sysdig:

  1. Missing manual labeling: The upper left and right corners of the manual contain parentheses instead of sysdig-related content, with no edit time or packet name at the end (refer to net-tools/arp).

  2. Content is not updated in a timely manner: Type sysdig proc.name is ko sysdig prompt filter error at index 10, line 1, column 11: expected a valid check operator: one of 'exists', '<=', '<', '>=', '>', '=', '=', '=', '=', '=', '! =', '=', '! =', 'glob', 'contains', 'contains', 'icontains', 'bcontains', 'startswith', 'bstartswith', 'endswith', 'intersects', 'in', 'pmatch', but I can't find in the manual 'bcontains ', intersects, pmatch, startswitch, endswitch

@wasup-yash
Copy link

wasup-yash commented Dec 12, 2023

hey, I wanted to work on this issue to add enough details required as mentioned, can someone point me to where it needs to be updated? or would like to discuss more about this (The slack link is not working for me idk why? )

@therealbobo
Copy link
Contributor

hi there! Thank you to pointing it out! @unknowndevQwQ
We just need to update 2 files:

  • sysdig.md
  • csysdig.md
    Then, after installing pandoc, it will just matter or launching cmake with the man targets (it would be even better if the new man will be generated with a GitHub Actions 😄). @wasup-yash

@wasup-yash
Copy link

About the second point where in the issue
can't find in the manual 'bcontains ', intersects, pmatch, startswitch, endswitch

so do I need to add these in the below conmmands with like icontains , contains ?

$ sysdig proc.name=cat
The list of available fields can be obtained with 'sysdig -l'. Filter expressions can use one of these comparison operators: =, !=, <, <=, >, >=, contains, icontains, in and exists. e.g.

also could not able to locate the issue in the given manualssysdig.md and csysdig.md
am i missing something here , what do i need to know in order to do resolve it ?

@unknowndevQwQ
Copy link
Author

About the second point where in the issue can't find in the manual 'bcontains ', intersects, pmatch, startswitch, endswitch

so do I need to add these in the below conmmands with like icontains , contains ?

$ sysdig proc.name=cat The list of available fields can be obtained with 'sysdig -l'. Filter expressions can use one of these comparison operators: =, !=, <, <=, >, >=, contains, icontains, in and exists. e.g.

also could not able to locate the issue in the given manualssysdig.md and csysdig.md am i missing something here , what do i need to know in order to do resolve it ?

@therealbobo Any suggestions on this issue?

Copy link

github-actions bot commented Oct 7, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the stale label Oct 7, 2024
@therealbobo therealbobo removed the stale label Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants
@therealbobo @unknowndevQwQ @wasup-yash and others