Skip to content

ipcalc: add page #16132

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

ipcalc: add page #16132

wants to merge 2 commits into from

Conversation

Alex-Gekas
Copy link

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The page(s) follow the style guide.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known): 1.0.0

This pull request adds a new TLDR page for the ipcalc command-line utility.

ipcalc is used to calculate and display network information based on an IP address and subnet, such as:

  • Netmask
  • Broadcast address
  • CIDR notation
  • Host range

The page includes common usage examples for:

  • Basic address lookup
  • CIDR notation
  • Custom netmask input
  • Short-format output
  • Version info

This PR addresses issue #16125.

@github-actions github-actions bot added new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers. labels Apr 8, 2025
@MachiavelliII
Copy link
Member

Hi Alex, it seems that github.com/ipcalc/ipcalc doesn't exist.

# ipcalc

> A tool to calculate IP information (subnet, broadcast, host range) from an IP address and netmask.
> More information: <https://github.com/ipcalc/ipcalc>.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> More information: <https://github.com/ipcalc/ipcalc>.
> More information: <https://manned.org/ipcalc>.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the address found on the official ipcalc website https://github.com/kjokjo/ipcalc

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the official page jodies.de/ipcalc. It's already linked in the footer of manned.org/ipcalc

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean that jodies.de/ipcalc has a link to that github page. But looking at them, it's better to link manned. At least it has the options listed.

@Managor
Copy link
Collaborator

Managor commented Apr 8, 2025

ipcalc.md already exists in the linux folder https://github.com/tldr-pages/tldr/blob/main/pages/linux/ipcalc.md. I recommend moving that and then merging these two. Plain ipcalc {{192.168.0.1}} is for example missing in the existing page.

@Managor
Copy link
Collaborator

Managor commented Apr 8, 2025

Hmmm. Note that the existing ipcalc.md is greatly outdated

@Managor Managor changed the title Add ipcalc: calculate IP address and subnet information ipcalc: add page Apr 9, 2025

- Show only CIDR notation output:

`ipcalc -c {{192.168.0.1/24}}`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`ipcalc -c {{192.168.0.1/24}}`
`ipcalc {{[-c|--class]}} {{192.168.0.1/24}}`

Either use long options by themselves or use option placeholders.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Managor and @MachiavelliII — I’ve just pushed the changes.
Moved the page from linux/ to common/
Merged in the two original examples from the old linux/ipcalc.md
Removed the outdated Linux page
Replaced the broken GitHub link with https://jodies.de/ipcalc
Updated the option example to use the long form --class as suggested
Let me know if there’s anything else to tweak. Thanks!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Managor and @MachiavelliII — I’ve just pushed the changes.

Unfortunately I don't see any push

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You probably forgot to push the local changes.

@Managor
Copy link
Collaborator

Managor commented Apr 16, 2025

@Alex-Gekas Can you fix the issues in this PR? You have not pushed any changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants